From 6096d3b32f925774606133590d0e9ea5c6eba2db Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:07 +0000 Subject: [PATCH 01/31] feat(analyticshub): update the api #### analyticshub:v1 The following keys were added: - schemas.GooglePubsubV1Subscription.properties.messageTransforms (Total Keys: 2) - schemas.JavaScriptUDF (Total Keys: 4) - schemas.MessageTransform (Total Keys: 4) --- ...ects.locations.dataExchanges.listings.html | 25 +++++++---- .../documents/analyticshub.v1.json | 41 ++++++++++++++++++- 2 files changed, 56 insertions(+), 10 deletions(-) diff --git a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html index 322db825641..76064b4fab8 100644 --- a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html +++ b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html @@ -108,7 +108,7 @@

Instance Methods

setIamPolicy(resource, body=None, x__xgafv=None)

Sets the IAM policy.

- subscribe(name, body=None, x__xgafv=None)

+ subscribe(name, body, x__xgafv=None)

Subscribes to a listing. Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.

testIamPermissions(resource, body=None, x__xgafv=None)

@@ -130,7 +130,7 @@

Method Details

{ # A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data. "bigqueryDataset": { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Required. Shared dataset i.e. BigQuery dataset source. - "dataset": "A String", # Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` + "dataset": "A String", # Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` "restrictedExportPolicy": { # Restricted export policy used to configure restricted export on linked dataset. # Optional. If set, restricted export policy will be propagated and enforced on the linked dataset. "enabled": True or False, # Optional. If true, enable restricted export. "restrictDirectTableAccess": True or False, # Optional. If true, restrict direct table access (read api/tabledata.list) on linked table. @@ -194,7 +194,7 @@

Method Details

{ # A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data. "bigqueryDataset": { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Required. Shared dataset i.e. BigQuery dataset source. - "dataset": "A String", # Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` + "dataset": "A String", # Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` "restrictedExportPolicy": { # Restricted export policy used to configure restricted export on linked dataset. # Optional. If set, restricted export policy will be propagated and enforced on the linked dataset. "enabled": True or False, # Optional. If true, enable restricted export. "restrictDirectTableAccess": True or False, # Optional. If true, restrict direct table access (read api/tabledata.list) on linked table. @@ -282,7 +282,7 @@

Method Details

{ # A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data. "bigqueryDataset": { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Required. Shared dataset i.e. BigQuery dataset source. - "dataset": "A String", # Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` + "dataset": "A String", # Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` "restrictedExportPolicy": { # Restricted export policy used to configure restricted export on linked dataset. # Optional. If set, restricted export policy will be propagated and enforced on the linked dataset. "enabled": True or False, # Optional. If true, enable restricted export. "restrictDirectTableAccess": True or False, # Optional. If true, restrict direct table access (read api/tabledata.list) on linked table. @@ -412,7 +412,7 @@

Method Details

"listings": [ # The list of Listing. { # A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data. "bigqueryDataset": { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Required. Shared dataset i.e. BigQuery dataset source. - "dataset": "A String", # Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` + "dataset": "A String", # Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` "restrictedExportPolicy": { # Restricted export policy used to configure restricted export on linked dataset. # Optional. If set, restricted export policy will be propagated and enforced on the linked dataset. "enabled": True or False, # Optional. If true, enable restricted export. "restrictDirectTableAccess": True or False, # Optional. If true, restrict direct table access (read api/tabledata.list) on linked table. @@ -563,7 +563,7 @@

Method Details

{ # A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data. "bigqueryDataset": { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Required. Shared dataset i.e. BigQuery dataset source. - "dataset": "A String", # Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` + "dataset": "A String", # Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` "restrictedExportPolicy": { # Restricted export policy used to configure restricted export on linked dataset. # Optional. If set, restricted export policy will be propagated and enforced on the linked dataset. "enabled": True or False, # Optional. If true, enable restricted export. "restrictDirectTableAccess": True or False, # Optional. If true, restrict direct table access (read api/tabledata.list) on linked table. @@ -627,7 +627,7 @@

Method Details

{ # A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data. "bigqueryDataset": { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Required. Shared dataset i.e. BigQuery dataset source. - "dataset": "A String", # Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` + "dataset": "A String", # Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` "restrictedExportPolicy": { # Restricted export policy used to configure restricted export on linked dataset. # Optional. If set, restricted export policy will be propagated and enforced on the linked dataset. "enabled": True or False, # Optional. If true, enable restricted export. "restrictDirectTableAccess": True or False, # Optional. If true, restrict direct table access (read api/tabledata.list) on linked table. @@ -767,7 +767,7 @@

Method Details

- subscribe(name, body=None, x__xgafv=None) + subscribe(name, body, x__xgafv=None)
Subscribes to a listing. Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.
 
 Args:
@@ -836,6 +836,15 @@ 

Method Details

"a_key": "A String", }, "messageRetentionDuration": "A String", # Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes. + "messageTransforms": [ # Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified. + { # All supported message transforms types. + "enabled": True or False, # Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`. + "javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`. + "code": "A String", # Required. JavaScript code that contains a function `function_name` with the below signature: ``` /** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { } ``` + "functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages. + }, + }, + ], "name": "A String", # Required. Name of the subscription. Format is `projects/{project}/subscriptions/{sub}`. "pushConfig": { # Configuration for a push delivery endpoint. # Optional. If push delivery is used with this subscription, this field is used to configure it. "attributes": { # Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: `attributes { "x-goog-version": "v1" }` diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1.json index ab00e85fe17..8c311ab890c 100644 --- a/googleapiclient/discovery_cache/documents/analyticshub.v1.json +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1.json @@ -1022,7 +1022,7 @@ } } }, -"revision": "20250126", +"revision": "20250203", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AnalyticsHubSubscriptionInfo": { @@ -1160,7 +1160,7 @@ "id": "BigQueryDatasetSource", "properties": { "dataset": { -"description": "Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`", +"description": "Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`", "type": "string" }, "restrictedExportPolicy": { @@ -1620,6 +1620,13 @@ "format": "google-duration", "type": "string" }, +"messageTransforms": { +"description": "Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified.", +"items": { +"$ref": "MessageTransform" +}, +"type": "array" +}, "name": { "description": "Required. Name of the subscription. Format is `projects/{project}/subscriptions/{sub}`.", "type": "string" @@ -1660,6 +1667,21 @@ }, "type": "object" }, +"JavaScriptUDF": { +"description": "User-defined JavaScript function that can transform or filter a Pub/Sub message.", +"id": "JavaScriptUDF", +"properties": { +"code": { +"description": "Required. JavaScript code that contains a function `function_name` with the below signature: ``` /** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { } ```", +"type": "string" +}, +"functionName": { +"description": "Required. Name of the JavasScript function that should applied to Pub/Sub messages.", +"type": "string" +} +}, +"type": "object" +}, "LinkedResource": { "description": "Reference to a linked resource tracked by this Subscription.", "id": "LinkedResource", @@ -1927,6 +1949,21 @@ }, "type": "object" }, +"MessageTransform": { +"description": "All supported message transforms types.", +"id": "MessageTransform", +"properties": { +"enabled": { +"description": "Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`.", +"type": "boolean" +}, +"javascriptUdf": { +"$ref": "JavaScriptUDF", +"description": "Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`." +} +}, +"type": "object" +}, "NoWrapper": { "description": "Sets the `data` field as the HTTP body for delivery.", "id": "NoWrapper", From cf5a6691fe84de6e0624633edf99beafdb98c0b2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:07 +0000 Subject: [PATCH 02/31] feat(bigquery): update the api #### bigquery:v2 The following keys were added: - resources.rowAccessPolicies.methods.batchDelete (Total Keys: 19) - resources.rowAccessPolicies.methods.delete (Total Keys: 24) - resources.rowAccessPolicies.methods.get (Total Keys: 23) - resources.rowAccessPolicies.methods.insert (Total Keys: 20) - resources.rowAccessPolicies.methods.update (Total Keys: 24) - schemas.BatchDeleteRowAccessPoliciesRequest (Total Keys: 5) - schemas.JobConfigurationQuery.properties.writeIncrementalResults.type (Total Keys: 1) - schemas.QueryRequest.properties.writeIncrementalResults.type (Total Keys: 1) - schemas.RowAccessPolicy.properties.grantees (Total Keys: 2) - schemas.StoredColumnsUnusedReason (Total Keys: 6) - schemas.StoredColumnsUsage (Total Keys: 6) - schemas.TrainingOptions.properties.forecastLimitLowerBound (Total Keys: 2) - schemas.TrainingOptions.properties.forecastLimitUpperBound (Total Keys: 2) - schemas.VectorSearchStatistics.properties.storedColumnsUsages (Total Keys: 2) --- docs/dyn/bigquery_v2.jobs.html | 111 ++++++ docs/dyn/bigquery_v2.models.html | 16 + docs/dyn/bigquery_v2.rowAccessPolicies.html | 199 ++++++++++ .../documents/bigquery.v2.json | 361 +++++++++++++++++- 4 files changed, 686 insertions(+), 1 deletion(-) diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index 1f311640876..bb75284a32f 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -546,6 +546,7 @@

Method Details

}, ], "writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. + "writeIncrementalResults": True or False, # Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available. }, }, "etag": "A String", # Output only. A hash of this resource. @@ -1049,6 +1050,8 @@

Method Details

"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -1445,6 +1448,25 @@

Method Details

}, ], "indexUsageMode": "A String", # Specifies the index usage mode for the query. + "storedColumnsUsages": [ # Specifies the usage of stored columns in the query when stored columns are used in the query. + { # Indicates the stored columns usage in the query. + "baseTable": { # Specifies the base table. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + "isQueryAccelerated": True or False, # Specifies whether the query was accelerated with stored columns. + "storedColumnsUnusedReasons": [ # If stored columns were not used, explain why. + { # If the stored column was not used, explain why. + "code": "A String", # Specifies the high-level reason for the unused scenario, each reason must have a code associated. + "message": "A String", # Specifies the detailed description for the scenario. + "uncoveredColumns": [ # Specifies which columns were not covered by the stored columns for the specified code up to 20 columns. This is populated when the code is STORED_COLUMNS_COVER_INSUFFICIENT and BASE_TABLE_HAS_CLS. + "A String", + ], + }, + ], + }, + ], }, }, "quotaDeferments": [ # Output only. Quotas which delayed this job's start time. @@ -1966,6 +1988,7 @@

Method Details

}, ], "writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. + "writeIncrementalResults": True or False, # Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available. }, }, "etag": "A String", # Output only. A hash of this resource. @@ -2469,6 +2492,8 @@

Method Details

"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -2865,6 +2890,25 @@

Method Details

}, ], "indexUsageMode": "A String", # Specifies the index usage mode for the query. + "storedColumnsUsages": [ # Specifies the usage of stored columns in the query when stored columns are used in the query. + { # Indicates the stored columns usage in the query. + "baseTable": { # Specifies the base table. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + "isQueryAccelerated": True or False, # Specifies whether the query was accelerated with stored columns. + "storedColumnsUnusedReasons": [ # If stored columns were not used, explain why. + { # If the stored column was not used, explain why. + "code": "A String", # Specifies the high-level reason for the unused scenario, each reason must have a code associated. + "message": "A String", # Specifies the detailed description for the scenario. + "uncoveredColumns": [ # Specifies which columns were not covered by the stored columns for the specified code up to 20 columns. This is populated when the code is STORED_COLUMNS_COVER_INSUFFICIENT and BASE_TABLE_HAS_CLS. + "A String", + ], + }, + ], + }, + ], }, }, "quotaDeferments": [ # Output only. Quotas which delayed this job's start time. @@ -3467,6 +3511,7 @@

Method Details

}, ], "writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. + "writeIncrementalResults": True or False, # Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available. }, }, "etag": "A String", # Output only. A hash of this resource. @@ -3970,6 +4015,8 @@

Method Details

"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -4366,6 +4413,25 @@

Method Details

}, ], "indexUsageMode": "A String", # Specifies the index usage mode for the query. + "storedColumnsUsages": [ # Specifies the usage of stored columns in the query when stored columns are used in the query. + { # Indicates the stored columns usage in the query. + "baseTable": { # Specifies the base table. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + "isQueryAccelerated": True or False, # Specifies whether the query was accelerated with stored columns. + "storedColumnsUnusedReasons": [ # If stored columns were not used, explain why. + { # If the stored column was not used, explain why. + "code": "A String", # Specifies the high-level reason for the unused scenario, each reason must have a code associated. + "message": "A String", # Specifies the detailed description for the scenario. + "uncoveredColumns": [ # Specifies which columns were not covered by the stored columns for the specified code up to 20 columns. This is populated when the code is STORED_COLUMNS_COVER_INSUFFICIENT and BASE_TABLE_HAS_CLS. + "A String", + ], + }, + ], + }, + ], }, }, "quotaDeferments": [ # Output only. Quotas which delayed this job's start time. @@ -4858,6 +4924,7 @@

Method Details

}, ], "writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. + "writeIncrementalResults": True or False, # Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available. }, }, "etag": "A String", # Output only. A hash of this resource. @@ -5361,6 +5428,8 @@

Method Details

"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -5757,6 +5826,25 @@

Method Details

}, ], "indexUsageMode": "A String", # Specifies the index usage mode for the query. + "storedColumnsUsages": [ # Specifies the usage of stored columns in the query when stored columns are used in the query. + { # Indicates the stored columns usage in the query. + "baseTable": { # Specifies the base table. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + "isQueryAccelerated": True or False, # Specifies whether the query was accelerated with stored columns. + "storedColumnsUnusedReasons": [ # If stored columns were not used, explain why. + { # If the stored column was not used, explain why. + "code": "A String", # Specifies the high-level reason for the unused scenario, each reason must have a code associated. + "message": "A String", # Specifies the detailed description for the scenario. + "uncoveredColumns": [ # Specifies which columns were not covered by the stored columns for the specified code up to 20 columns. This is populated when the code is STORED_COLUMNS_COVER_INSUFFICIENT and BASE_TABLE_HAS_CLS. + "A String", + ], + }, + ], + }, + ], }, }, "quotaDeferments": [ # Output only. Quotas which delayed this job's start time. @@ -6272,6 +6360,7 @@

Method Details

}, ], "writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. + "writeIncrementalResults": True or False, # Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available. }, }, "errorResult": { # Error details. # A result object that will be present only if the job has failed. @@ -6777,6 +6866,8 @@

Method Details

"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -7173,6 +7264,25 @@

Method Details

}, ], "indexUsageMode": "A String", # Specifies the index usage mode for the query. + "storedColumnsUsages": [ # Specifies the usage of stored columns in the query when stored columns are used in the query. + { # Indicates the stored columns usage in the query. + "baseTable": { # Specifies the base table. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + "isQueryAccelerated": True or False, # Specifies whether the query was accelerated with stored columns. + "storedColumnsUnusedReasons": [ # If stored columns were not used, explain why. + { # If the stored column was not used, explain why. + "code": "A String", # Specifies the high-level reason for the unused scenario, each reason must have a code associated. + "message": "A String", # Specifies the detailed description for the scenario. + "uncoveredColumns": [ # Specifies which columns were not covered by the stored columns for the specified code up to 20 columns. This is populated when the code is STORED_COLUMNS_COVER_INSUFFICIENT and BASE_TABLE_HAS_CLS. + "A String", + ], + }, + ], + }, + ], }, }, "quotaDeferments": [ # Output only. Quotas which delayed this job's start time. @@ -7324,6 +7434,7 @@

Method Details

"timeoutMs": 42, # Optional. Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing to wait for the query to complete. By default, this limit is 10 seconds (10,000 milliseconds). If the query is complete, the jobComplete field in the response is true. If the query has not yet completed, jobComplete is false. You can request a longer timeout period in the timeoutMs field. However, the call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. If jobComplete is false, you can continue to wait for the query to complete by calling the getQueryResults method until the jobComplete field in the getQueryResults response is true. "useLegacySql": true, # Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's GoogleSQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false. "useQueryCache": true, # Optional. Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true. + "writeIncrementalResults": True or False, # Optional. This is only supported for SELECT query. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/bigquery_v2.models.html b/docs/dyn/bigquery_v2.models.html index ccdd0aab880..c265f530b21 100644 --- a/docs/dyn/bigquery_v2.models.html +++ b/docs/dyn/bigquery_v2.models.html @@ -687,6 +687,8 @@

Method Details

"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -1081,6 +1083,8 @@

Method Details

"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -1763,6 +1767,8 @@

Method Details

"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -2157,6 +2163,8 @@

Method Details

"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -2848,6 +2856,8 @@

Method Details

"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -3242,6 +3252,8 @@

Method Details

"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -3912,6 +3924,8 @@

Method Details

"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -4306,6 +4320,8 @@

Method Details

"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], diff --git a/docs/dyn/bigquery_v2.rowAccessPolicies.html b/docs/dyn/bigquery_v2.rowAccessPolicies.html index c2bbb393a1f..fe7b0b10edc 100644 --- a/docs/dyn/bigquery_v2.rowAccessPolicies.html +++ b/docs/dyn/bigquery_v2.rowAccessPolicies.html @@ -74,12 +74,24 @@

BigQuery API . rowAccessPolicies

Instance Methods

+

+ batchDelete(projectId, datasetId, tableId, body=None, x__xgafv=None)

+

Deletes provided row access policies.

close()

Close httplib2 connections.

+

+ delete(projectId, datasetId, tableId, policyId, force=None, x__xgafv=None)

+

Deletes a row access policy.

+

+ get(projectId, datasetId, tableId, policyId, x__xgafv=None)

+

Gets the specified row access policy by policy ID.

getIamPolicy(resource, body=None, x__xgafv=None)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

+

+ insert(projectId, datasetId, tableId, body=None, x__xgafv=None)

+

Creates a row access policy.

list(projectId, datasetId, tableId, pageSize=None, pageToken=None, x__xgafv=None)

Lists all row access policies on the specified table.

@@ -89,12 +101,91 @@

Instance Methods

testIamPermissions(resource, body=None, x__xgafv=None)

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.

+

+ update(projectId, datasetId, tableId, policyId, body=None, x__xgafv=None)

+

Updates a row access policy.

Method Details

+
+ batchDelete(projectId, datasetId, tableId, body=None, x__xgafv=None) +
Deletes provided row access policies.
+
+Args:
+  projectId: string, Required. Project ID of the table to delete the row access policies. (required)
+  datasetId: string, Required. Dataset ID of the table to delete the row access policies. (required)
+  tableId: string, Required. Table ID of the table to delete the row access policies. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for the BatchDeleteRowAccessPoliciesRequest method.
+  "force": True or False, # If set to true, it deletes the row access policy even if it's the last row access policy on the table and the deletion will widen the access rather narrowing it.
+  "policyIds": [ # Required. Policy IDs of the row access policies.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+
+
close()
Close httplib2 connections.
+
+ delete(projectId, datasetId, tableId, policyId, force=None, x__xgafv=None) +
Deletes a row access policy.
+
+Args:
+  projectId: string, Required. Project ID of the table to delete the row access policy. (required)
+  datasetId: string, Required. Dataset ID of the table to delete the row access policy. (required)
+  tableId: string, Required. Table ID of the table to delete the row access policy. (required)
+  policyId: string, Required. Policy ID of the row access policy. (required)
+  force: boolean, If set to true, it deletes the row access policy even if it's the last row access policy on the table and the deletion will widen the access rather narrowing it.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+
+ +
+ get(projectId, datasetId, tableId, policyId, x__xgafv=None) +
Gets the specified row access policy by policy ID.
+
+Args:
+  projectId: string, Required. Project ID of the table to get the row access policy. (required)
+  datasetId: string, Required. Dataset ID of the table to get the row access policy. (required)
+  tableId: string, Required. Table ID of the table to get the row access policy. (required)
+  policyId: string, Required. Policy ID of the row access policy. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents access on a subset of rows on the specified table, defined by its filter predicate. Access to the subset of rows is controlled by its IAM policy.
+  "creationTime": "A String", # Output only. The time when this row access policy was created, in milliseconds since the epoch.
+  "etag": "A String", # Output only. A hash of this resource.
+  "filterPredicate": "A String", # Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region="EU" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0
+  "grantees": [ # Optional. Input only. The optional list of iam_member users or groups that specifies the initial members that the row-level access policy should be created with. grantees types: - "user:alice@example.com": An email address that represents a specific Google account. - "serviceAccount:my-other-app@appspot.gserviceaccount.com": An email address that represents a service account. - "group:admins@example.com": An email address that represents a Google group. - "domain:example.com":The Google Workspace domain (primary) that represents all the users of that domain. - "allAuthenticatedUsers": A special identifier that represents all service accounts and all users on the internet who have authenticated with a Google Account. This identifier includes accounts that aren't connected to a Google Workspace or Cloud Identity domain, such as personal Gmail accounts. Users who aren't authenticated, such as anonymous visitors, aren't included. - "allUsers":A special identifier that represents anyone who is on the internet, including authenticated and unauthenticated users. Because BigQuery requires authentication before a user can access the service, allUsers includes only authenticated users.
+    "A String",
+  ],
+  "lastModifiedTime": "A String", # Output only. The time when this row access policy was last modified, in milliseconds since the epoch.
+  "rowAccessPolicyReference": { # Id path of a row access policy. # Required. Reference describing the ID of this row access policy.
+    "datasetId": "A String", # Required. The ID of the dataset containing this row access policy.
+    "policyId": "A String", # Required. The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
+    "projectId": "A String", # Required. The ID of the project containing this row access policy.
+    "tableId": "A String", # Required. The ID of the table containing this row access policy.
+  },
+}
+
+
getIamPolicy(resource, body=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
@@ -151,6 +242,58 @@ 

Method Details

}
+
+ insert(projectId, datasetId, tableId, body=None, x__xgafv=None) +
Creates a row access policy.
+
+Args:
+  projectId: string, Required. Project ID of the table to get the row access policy. (required)
+  datasetId: string, Required. Dataset ID of the table to get the row access policy. (required)
+  tableId: string, Required. Table ID of the table to get the row access policy. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents access on a subset of rows on the specified table, defined by its filter predicate. Access to the subset of rows is controlled by its IAM policy.
+  "creationTime": "A String", # Output only. The time when this row access policy was created, in milliseconds since the epoch.
+  "etag": "A String", # Output only. A hash of this resource.
+  "filterPredicate": "A String", # Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region="EU" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0
+  "grantees": [ # Optional. Input only. The optional list of iam_member users or groups that specifies the initial members that the row-level access policy should be created with. grantees types: - "user:alice@example.com": An email address that represents a specific Google account. - "serviceAccount:my-other-app@appspot.gserviceaccount.com": An email address that represents a service account. - "group:admins@example.com": An email address that represents a Google group. - "domain:example.com":The Google Workspace domain (primary) that represents all the users of that domain. - "allAuthenticatedUsers": A special identifier that represents all service accounts and all users on the internet who have authenticated with a Google Account. This identifier includes accounts that aren't connected to a Google Workspace or Cloud Identity domain, such as personal Gmail accounts. Users who aren't authenticated, such as anonymous visitors, aren't included. - "allUsers":A special identifier that represents anyone who is on the internet, including authenticated and unauthenticated users. Because BigQuery requires authentication before a user can access the service, allUsers includes only authenticated users.
+    "A String",
+  ],
+  "lastModifiedTime": "A String", # Output only. The time when this row access policy was last modified, in milliseconds since the epoch.
+  "rowAccessPolicyReference": { # Id path of a row access policy. # Required. Reference describing the ID of this row access policy.
+    "datasetId": "A String", # Required. The ID of the dataset containing this row access policy.
+    "policyId": "A String", # Required. The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
+    "projectId": "A String", # Required. The ID of the project containing this row access policy.
+    "tableId": "A String", # Required. The ID of the table containing this row access policy.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents access on a subset of rows on the specified table, defined by its filter predicate. Access to the subset of rows is controlled by its IAM policy.
+  "creationTime": "A String", # Output only. The time when this row access policy was created, in milliseconds since the epoch.
+  "etag": "A String", # Output only. A hash of this resource.
+  "filterPredicate": "A String", # Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region="EU" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0
+  "grantees": [ # Optional. Input only. The optional list of iam_member users or groups that specifies the initial members that the row-level access policy should be created with. grantees types: - "user:alice@example.com": An email address that represents a specific Google account. - "serviceAccount:my-other-app@appspot.gserviceaccount.com": An email address that represents a service account. - "group:admins@example.com": An email address that represents a Google group. - "domain:example.com":The Google Workspace domain (primary) that represents all the users of that domain. - "allAuthenticatedUsers": A special identifier that represents all service accounts and all users on the internet who have authenticated with a Google Account. This identifier includes accounts that aren't connected to a Google Workspace or Cloud Identity domain, such as personal Gmail accounts. Users who aren't authenticated, such as anonymous visitors, aren't included. - "allUsers":A special identifier that represents anyone who is on the internet, including authenticated and unauthenticated users. Because BigQuery requires authentication before a user can access the service, allUsers includes only authenticated users.
+    "A String",
+  ],
+  "lastModifiedTime": "A String", # Output only. The time when this row access policy was last modified, in milliseconds since the epoch.
+  "rowAccessPolicyReference": { # Id path of a row access policy. # Required. Reference describing the ID of this row access policy.
+    "datasetId": "A String", # Required. The ID of the dataset containing this row access policy.
+    "policyId": "A String", # Required. The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
+    "projectId": "A String", # Required. The ID of the project containing this row access policy.
+    "tableId": "A String", # Required. The ID of the table containing this row access policy.
+  },
+}
+
+
list(projectId, datasetId, tableId, pageSize=None, pageToken=None, x__xgafv=None)
Lists all row access policies on the specified table.
@@ -176,6 +319,9 @@ 

Method Details

"creationTime": "A String", # Output only. The time when this row access policy was created, in milliseconds since the epoch. "etag": "A String", # Output only. A hash of this resource. "filterPredicate": "A String", # Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region="EU" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0 + "grantees": [ # Optional. Input only. The optional list of iam_member users or groups that specifies the initial members that the row-level access policy should be created with. grantees types: - "user:alice@example.com": An email address that represents a specific Google account. - "serviceAccount:my-other-app@appspot.gserviceaccount.com": An email address that represents a service account. - "group:admins@example.com": An email address that represents a Google group. - "domain:example.com":The Google Workspace domain (primary) that represents all the users of that domain. - "allAuthenticatedUsers": A special identifier that represents all service accounts and all users on the internet who have authenticated with a Google Account. This identifier includes accounts that aren't connected to a Google Workspace or Cloud Identity domain, such as personal Gmail accounts. Users who aren't authenticated, such as anonymous visitors, aren't included. - "allUsers":A special identifier that represents anyone who is on the internet, including authenticated and unauthenticated users. Because BigQuery requires authentication before a user can access the service, allUsers includes only authenticated users. + "A String", + ], "lastModifiedTime": "A String", # Output only. The time when this row access policy was last modified, in milliseconds since the epoch. "rowAccessPolicyReference": { # Id path of a row access policy. # Required. Reference describing the ID of this row access policy. "datasetId": "A String", # Required. The ID of the dataset containing this row access policy. @@ -232,4 +378,57 @@

Method Details

}
+
+ update(projectId, datasetId, tableId, policyId, body=None, x__xgafv=None) +
Updates a row access policy.
+
+Args:
+  projectId: string, Required. Project ID of the table to get the row access policy. (required)
+  datasetId: string, Required. Dataset ID of the table to get the row access policy. (required)
+  tableId: string, Required. Table ID of the table to get the row access policy. (required)
+  policyId: string, Required. Policy ID of the row access policy. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents access on a subset of rows on the specified table, defined by its filter predicate. Access to the subset of rows is controlled by its IAM policy.
+  "creationTime": "A String", # Output only. The time when this row access policy was created, in milliseconds since the epoch.
+  "etag": "A String", # Output only. A hash of this resource.
+  "filterPredicate": "A String", # Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region="EU" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0
+  "grantees": [ # Optional. Input only. The optional list of iam_member users or groups that specifies the initial members that the row-level access policy should be created with. grantees types: - "user:alice@example.com": An email address that represents a specific Google account. - "serviceAccount:my-other-app@appspot.gserviceaccount.com": An email address that represents a service account. - "group:admins@example.com": An email address that represents a Google group. - "domain:example.com":The Google Workspace domain (primary) that represents all the users of that domain. - "allAuthenticatedUsers": A special identifier that represents all service accounts and all users on the internet who have authenticated with a Google Account. This identifier includes accounts that aren't connected to a Google Workspace or Cloud Identity domain, such as personal Gmail accounts. Users who aren't authenticated, such as anonymous visitors, aren't included. - "allUsers":A special identifier that represents anyone who is on the internet, including authenticated and unauthenticated users. Because BigQuery requires authentication before a user can access the service, allUsers includes only authenticated users.
+    "A String",
+  ],
+  "lastModifiedTime": "A String", # Output only. The time when this row access policy was last modified, in milliseconds since the epoch.
+  "rowAccessPolicyReference": { # Id path of a row access policy. # Required. Reference describing the ID of this row access policy.
+    "datasetId": "A String", # Required. The ID of the dataset containing this row access policy.
+    "policyId": "A String", # Required. The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
+    "projectId": "A String", # Required. The ID of the project containing this row access policy.
+    "tableId": "A String", # Required. The ID of the table containing this row access policy.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents access on a subset of rows on the specified table, defined by its filter predicate. Access to the subset of rows is controlled by its IAM policy.
+  "creationTime": "A String", # Output only. The time when this row access policy was created, in milliseconds since the epoch.
+  "etag": "A String", # Output only. A hash of this resource.
+  "filterPredicate": "A String", # Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region="EU" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0
+  "grantees": [ # Optional. Input only. The optional list of iam_member users or groups that specifies the initial members that the row-level access policy should be created with. grantees types: - "user:alice@example.com": An email address that represents a specific Google account. - "serviceAccount:my-other-app@appspot.gserviceaccount.com": An email address that represents a service account. - "group:admins@example.com": An email address that represents a Google group. - "domain:example.com":The Google Workspace domain (primary) that represents all the users of that domain. - "allAuthenticatedUsers": A special identifier that represents all service accounts and all users on the internet who have authenticated with a Google Account. This identifier includes accounts that aren't connected to a Google Workspace or Cloud Identity domain, such as personal Gmail accounts. Users who aren't authenticated, such as anonymous visitors, aren't included. - "allUsers":A special identifier that represents anyone who is on the internet, including authenticated and unauthenticated users. Because BigQuery requires authentication before a user can access the service, allUsers includes only authenticated users.
+    "A String",
+  ],
+  "lastModifiedTime": "A String", # Output only. The time when this row access policy was last modified, in milliseconds since the epoch.
+  "rowAccessPolicyReference": { # Id path of a row access policy. # Required. Reference describing the ID of this row access policy.
+    "datasetId": "A String", # Required. The ID of the dataset containing this row access policy.
+    "policyId": "A String", # Required. The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
+    "projectId": "A String", # Required. The ID of the project containing this row access policy.
+    "tableId": "A String", # Required. The ID of the table containing this row access policy.
+  },
+}
+
+ \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index 96983cea2f5..cd50d37a65c 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -1392,6 +1392,153 @@ }, "rowAccessPolicies": { "methods": { +"batchDelete": { +"description": "Deletes provided row access policies.", +"flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies:batchDelete", +"httpMethod": "POST", +"id": "bigquery.rowAccessPolicies.batchDelete", +"parameterOrder": [ +"projectId", +"datasetId", +"tableId" +], +"parameters": { +"datasetId": { +"description": "Required. Dataset ID of the table to delete the row access policies.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"projectId": { +"description": "Required. Project ID of the table to delete the row access policies.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"tableId": { +"description": "Required. Table ID of the table to delete the row access policies.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "projects/{+projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies:batchDelete", +"request": { +"$ref": "BatchDeleteRowAccessPoliciesRequest" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"delete": { +"description": "Deletes a row access policy.", +"flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}", +"httpMethod": "DELETE", +"id": "bigquery.rowAccessPolicies.delete", +"parameterOrder": [ +"projectId", +"datasetId", +"tableId", +"policyId" +], +"parameters": { +"datasetId": { +"description": "Required. Dataset ID of the table to delete the row access policy.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"force": { +"description": "If set to true, it deletes the row access policy even if it's the last row access policy on the table and the deletion will widen the access rather narrowing it.", +"location": "query", +"type": "boolean" +}, +"policyId": { +"description": "Required. Policy ID of the row access policy.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"projectId": { +"description": "Required. Project ID of the table to delete the row access policy.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"tableId": { +"description": "Required. Table ID of the table to delete the row access policy.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "projects/{+projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies/{+policyId}", +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"get": { +"description": "Gets the specified row access policy by policy ID.", +"flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}", +"httpMethod": "GET", +"id": "bigquery.rowAccessPolicies.get", +"parameterOrder": [ +"projectId", +"datasetId", +"tableId", +"policyId" +], +"parameters": { +"datasetId": { +"description": "Required. Dataset ID of the table to get the row access policy.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"policyId": { +"description": "Required. Policy ID of the row access policy.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"projectId": { +"description": "Required. Project ID of the table to get the row access policy.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"tableId": { +"description": "Required. Table ID of the table to get the row access policy.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "projects/{+projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies/{+policyId}", +"response": { +"$ref": "RowAccessPolicy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, "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": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}:getIamPolicy", @@ -1422,6 +1569,52 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, +"insert": { +"description": "Creates a row access policy.", +"flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies", +"httpMethod": "POST", +"id": "bigquery.rowAccessPolicies.insert", +"parameterOrder": [ +"projectId", +"datasetId", +"tableId" +], +"parameters": { +"datasetId": { +"description": "Required. Dataset ID of the table to get the row access policy.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"projectId": { +"description": "Required. Project ID of the table to get the row access policy.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"tableId": { +"description": "Required. Table ID of the table to get the row access policy.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "projects/{+projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies", +"request": { +"$ref": "RowAccessPolicy" +}, +"response": { +"$ref": "RowAccessPolicy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, "list": { "description": "Lists all row access policies on the specified table.", "flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies", @@ -1505,6 +1698,60 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] +}, +"update": { +"description": "Updates a row access policy.", +"flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}", +"httpMethod": "PUT", +"id": "bigquery.rowAccessPolicies.update", +"parameterOrder": [ +"projectId", +"datasetId", +"tableId", +"policyId" +], +"parameters": { +"datasetId": { +"description": "Required. Dataset ID of the table to get the row access policy.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"policyId": { +"description": "Required. Policy ID of the row access policy.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"projectId": { +"description": "Required. Project ID of the table to get the row access policy.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"tableId": { +"description": "Required. Table ID of the table to get the row access policy.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "projects/{+projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies/{+policyId}", +"request": { +"$ref": "RowAccessPolicy" +}, +"response": { +"$ref": "RowAccessPolicy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] } } }, @@ -2009,7 +2256,7 @@ } } }, -"revision": "20250112", +"revision": "20250128", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -2502,6 +2749,24 @@ }, "type": "object" }, +"BatchDeleteRowAccessPoliciesRequest": { +"description": "Request message for the BatchDeleteRowAccessPoliciesRequest method.", +"id": "BatchDeleteRowAccessPoliciesRequest", +"properties": { +"force": { +"description": "If set to true, it deletes the row access policy even if it's the last row access policy on the table and the deletion will widen the access rather narrowing it.", +"type": "boolean" +}, +"policyIds": { +"description": "Required. Policy IDs of the row access policies.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "BiEngineReason": { "description": "Reason why BI Engine didn't accelerate the query (or sub-query).", "id": "BiEngineReason", @@ -5388,6 +5653,10 @@ "writeDisposition": { "description": "Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.", "type": "string" +}, +"writeIncrementalResults": { +"description": "Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available.", +"type": "boolean" } }, "type": "object" @@ -7270,6 +7539,10 @@ "default": "true", "description": "Optional. Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true.", "type": "boolean" +}, +"writeIncrementalResults": { +"description": "Optional. This is only supported for SELECT query. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available.", +"type": "boolean" } }, "type": "object" @@ -7833,6 +8106,13 @@ "description": "Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region=\"EU\" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0", "type": "string" }, +"grantees": { +"description": "Optional. Input only. The optional list of iam_member users or groups that specifies the initial members that the row-level access policy should be created with. grantees types: - \"user:alice@example.com\": An email address that represents a specific Google account. - \"serviceAccount:my-other-app@appspot.gserviceaccount.com\": An email address that represents a service account. - \"group:admins@example.com\": An email address that represents a Google group. - \"domain:example.com\":The Google Workspace domain (primary) that represents all the users of that domain. - \"allAuthenticatedUsers\": A special identifier that represents all service accounts and all users on the internet who have authenticated with a Google Account. This identifier includes accounts that aren't connected to a Google Workspace or Cloud Identity domain, such as personal Gmail accounts. Users who aren't authenticated, such as anonymous visitors, aren't included. - \"allUsers\":A special identifier that represents anyone who is on the internet, including authenticated and unauthenticated users. Because BigQuery requires authentication before a user can access the service, allUsers includes only authenticated users.", +"items": { +"type": "string" +}, +"type": "array" +}, "lastModifiedTime": { "description": "Output only. The time when this row access policy was last modified, in milliseconds since the epoch.", "format": "google-datetime", @@ -8399,6 +8679,68 @@ }, "type": "object" }, +"StoredColumnsUnusedReason": { +"description": "If the stored column was not used, explain why.", +"id": "StoredColumnsUnusedReason", +"properties": { +"code": { +"description": "Specifies the high-level reason for the unused scenario, each reason must have a code associated.", +"enum": [ +"CODE_UNSPECIFIED", +"STORED_COLUMNS_COVER_INSUFFICIENT", +"BASE_TABLE_HAS_RLS", +"BASE_TABLE_HAS_CLS", +"UNSUPPORTED_PREFILTER", +"INTERNAL_ERROR", +"OTHER_REASON" +], +"enumDescriptions": [ +"Default value.", +"If stored columns do not fully cover the columns.", +"If the base table has RLS (Row Level Security).", +"If the base table has CLS (Column Level Security).", +"If the provided prefilter is not supported.", +"If an internal error is preventing stored columns from being used.", +"Indicates that the reason stored columns cannot be used in the query is not covered by any of the other StoredColumnsUnusedReason options." +], +"type": "string" +}, +"message": { +"description": "Specifies the detailed description for the scenario.", +"type": "string" +}, +"uncoveredColumns": { +"description": "Specifies which columns were not covered by the stored columns for the specified code up to 20 columns. This is populated when the code is STORED_COLUMNS_COVER_INSUFFICIENT and BASE_TABLE_HAS_CLS.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"StoredColumnsUsage": { +"description": "Indicates the stored columns usage in the query.", +"id": "StoredColumnsUsage", +"properties": { +"baseTable": { +"$ref": "TableReference", +"description": "Specifies the base table." +}, +"isQueryAccelerated": { +"description": "Specifies whether the query was accelerated with stored columns.", +"type": "boolean" +}, +"storedColumnsUnusedReasons": { +"description": "If stored columns were not used, explain why.", +"items": { +"$ref": "StoredColumnsUnusedReason" +}, +"type": "array" +} +}, +"type": "object" +}, "Streamingbuffer": { "id": "Streamingbuffer", "properties": { @@ -9584,6 +9926,16 @@ "description": "Whether the model should include intercept during model training.", "type": "boolean" }, +"forecastLimitLowerBound": { +"description": "The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html", +"format": "double", +"type": "number" +}, +"forecastLimitUpperBound": { +"description": "The forecast limit upper bound that was used during ARIMA model training with limits.", +"format": "double", +"type": "number" +}, "hiddenUnits": { "description": "Hidden units for dnn models.", "items": { @@ -10423,6 +10775,13 @@ "The entire vector search query used vector indexes." ], "type": "string" +}, +"storedColumnsUsages": { +"description": "Specifies the usage of stored columns in the query when stored columns are used in the query.", +"items": { +"$ref": "StoredColumnsUsage" +}, +"type": "array" } }, "type": "object" From 3370961c0d7fa5450c36bc8c1dfae434872cd4f5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:07 +0000 Subject: [PATCH 03/31] feat(certificatemanager): update the api #### certificatemanager:v1 The following keys were added: - schemas.Certificate.properties.usedBy (Total Keys: 3) - schemas.UsedBy (Total Keys: 4) --- ...er_v1.projects.locations.certificates.html | 20 +++++++++++++++++ .../documents/certificatemanager.v1.json | 22 ++++++++++++++++++- 2 files changed, 41 insertions(+), 1 deletion(-) diff --git a/docs/dyn/certificatemanager_v1.projects.locations.certificates.html b/docs/dyn/certificatemanager_v1.projects.locations.certificates.html index 48afabbf369..fdc80628115 100644 --- a/docs/dyn/certificatemanager_v1.projects.locations.certificates.html +++ b/docs/dyn/certificatemanager_v1.projects.locations.certificates.html @@ -150,6 +150,11 @@

Method Details

"pemPrivateKey": "A String", # Optional. Input only. The PEM-encoded private key of the leaf certificate. }, "updateTime": "A String", # Output only. The last update timestamp of a Certificate. + "usedBy": [ # Output only. The list of resources that use this Certificate. + { # Defines a resource that uses the certificate. + "name": "A String", # Output only. Full name of the resource https://google.aip.dev/122#full-resource-names, e.g. `//certificatemanager.googleapis.com/projects/*/locations/*/certificateMaps/*/certificateMapEntries/*` or `//compute.googleapis.com/projects/*/locations/*/targetHttpsProxies/*`. + }, + ], } certificateId: string, Required. A user-provided name of the certificate. @@ -271,6 +276,11 @@

Method Details

"pemPrivateKey": "A String", # Optional. Input only. The PEM-encoded private key of the leaf certificate. }, "updateTime": "A String", # Output only. The last update timestamp of a Certificate. + "usedBy": [ # Output only. The list of resources that use this Certificate. + { # Defines a resource that uses the certificate. + "name": "A String", # Output only. Full name of the resource https://google.aip.dev/122#full-resource-names, e.g. `//certificatemanager.googleapis.com/projects/*/locations/*/certificateMaps/*/certificateMapEntries/*` or `//compute.googleapis.com/projects/*/locations/*/targetHttpsProxies/*`. + }, + ], }
@@ -334,6 +344,11 @@

Method Details

"pemPrivateKey": "A String", # Optional. Input only. The PEM-encoded private key of the leaf certificate. }, "updateTime": "A String", # Output only. The last update timestamp of a Certificate. + "usedBy": [ # Output only. The list of resources that use this Certificate. + { # Defines a resource that uses the certificate. + "name": "A String", # Output only. Full name of the resource https://google.aip.dev/122#full-resource-names, e.g. `//certificatemanager.googleapis.com/projects/*/locations/*/certificateMaps/*/certificateMapEntries/*` or `//compute.googleapis.com/projects/*/locations/*/targetHttpsProxies/*`. + }, + ], }, ], "nextPageToken": "A String", # If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. @@ -406,6 +421,11 @@

Method Details

"pemPrivateKey": "A String", # Optional. Input only. The PEM-encoded private key of the leaf certificate. }, "updateTime": "A String", # Output only. The last update timestamp of a Certificate. + "usedBy": [ # Output only. The list of resources that use this Certificate. + { # Defines a resource that uses the certificate. + "name": "A String", # Output only. Full name of the resource https://google.aip.dev/122#full-resource-names, e.g. `//certificatemanager.googleapis.com/projects/*/locations/*/certificateMaps/*/certificateMapEntries/*` or `//compute.googleapis.com/projects/*/locations/*/targetHttpsProxies/*`. + }, + ], } updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. diff --git a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json index f703c93d13b..ea6b6c51975 100644 --- a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json +++ b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json @@ -1314,7 +1314,7 @@ } } }, -"revision": "20241204", +"revision": "20250203", "rootUrl": "https://certificatemanager.googleapis.com/", "schemas": { "AllowlistedCertificate": { @@ -1456,6 +1456,14 @@ "format": "google-datetime", "readOnly": true, "type": "string" +}, +"usedBy": { +"description": "Output only. The list of resources that use this Certificate.", +"items": { +"$ref": "UsedBy" +}, +"readOnly": true, +"type": "array" } }, "type": "object" @@ -2299,6 +2307,18 @@ } }, "type": "object" +}, +"UsedBy": { +"description": "Defines a resource that uses the certificate.", +"id": "UsedBy", +"properties": { +"name": { +"description": "Output only. Full name of the resource https://google.aip.dev/122#full-resource-names, e.g. `//certificatemanager.googleapis.com/projects/*/locations/*/certificateMaps/*/certificateMapEntries/*` or `//compute.googleapis.com/projects/*/locations/*/targetHttpsProxies/*`.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" } }, "servicePath": "", From 6b7a597cd890e0795b36938b047d9a59c22a045a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:08 +0000 Subject: [PATCH 04/31] feat(compute): update the api #### compute:alpha The following keys were deleted: - schemas.NetworkProfile.properties.zone.type (Total Keys: 1) The following keys were added: - resources.interconnectGroups.methods.createMembers (Total Keys: 16) - schemas.BackendService.properties.dynamicForwarding.$ref (Total Keys: 1) - schemas.BackendServiceDynamicForwarding (Total Keys: 6) - schemas.InterconnectAttachmentGroupsOperationalStatus.properties.attachmentStatuses (Total Keys: 2) - schemas.InterconnectAttachmentGroupsOperationalStatus.properties.configured.$ref (Total Keys: 1) - schemas.InterconnectAttachmentGroupsOperationalStatus.properties.intent.$ref (Total Keys: 1) - schemas.InterconnectAttachmentGroupsOperationalStatus.properties.operational.$ref (Total Keys: 1) - schemas.InterconnectAttachmentGroupsOperationalStatusAttachmentStatus (Total Keys: 6) - schemas.InterconnectGroupsCreateMembers (Total Keys: 28) - schemas.MachineImage.properties.params.$ref (Total Keys: 1) - schemas.MachineImageParams (Total Keys: 6) - schemas.ResourcePolicySnapshotSchedulePolicySnapshotProperties.properties.region.type (Total Keys: 1) - schemas.ResourcePolicyWorkloadPolicy.properties.acceleratorTopology.type (Total Keys: 1) - schemas.ResourcePolicyWorkloadPolicy.properties.maxTopologyDistance.type (Total Keys: 1) - schemas.SnapshotSettingsAccessLocation.properties.policy.type (Total Keys: 1) - schemas.VpnTunnel.properties.cipherSuite.$ref (Total Keys: 1) - schemas.VpnTunnelCipherSuite (Total Keys: 4) - schemas.VpnTunnelPhase1Algorithms (Total Keys: 10) - schemas.VpnTunnelPhase2Algorithms (Total Keys: 8) #### compute:beta The following keys were deleted: - schemas.NetworkProfile.properties.zone.type (Total Keys: 1) The following keys were added: - resources.advice.methods.calendarMode (Total Keys: 16) - resources.reservationBlocks.methods.performMaintenance (Total Keys: 24) - resources.reservations.methods.performMaintenance (Total Keys: 20) - schemas.CalendarModeAdviceRequest (Total Keys: 4) - schemas.CalendarModeAdviceResponse (Total Keys: 4) - schemas.CalendarModeRecommendation (Total Keys: 4) - schemas.FlexibleTimeRange (Total Keys: 14) - schemas.FutureResourcesRecommendation (Total Keys: 15) - schemas.FutureResourcesSpec (Total Keys: 35) - schemas.InstanceGroupManagerInstanceLifecyclePolicy.properties.onFailedHealthCheck.type (Total Keys: 1) - schemas.Interconnect.properties.wireGroups (Total Keys: 2) - schemas.NodeType.properties.maxVms (Total Keys: 2) - schemas.ReservationsBlocksPerformMaintenanceRequest (Total Keys: 3) - schemas.ReservationsPerformMaintenanceRequest (Total Keys: 3) #### compute:v1 The following keys were deleted: - schemas.NetworkProfile.properties.zone.type (Total Keys: 1) The following keys were added: - resources.networkFirewallPolicies.methods.addPacketMirroringRule (Total Keys: 24) - resources.networkFirewallPolicies.methods.getPacketMirroringRule (Total Keys: 18) - resources.networkFirewallPolicies.methods.patchPacketMirroringRule (Total Keys: 21) - resources.networkFirewallPolicies.methods.removePacketMirroringRule (Total Keys: 20) - schemas.FirewallPolicy.properties.packetMirroringRules (Total Keys: 2) - schemas.InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.properties.packetMirroringRules (Total Keys: 2) - schemas.NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy.properties.packetMirroringRules (Total Keys: 2) - schemas.NodeType.properties.maxVms (Total Keys: 2) - schemas.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.properties.packetMirroringRules (Total Keys: 2) --- docs/dyn/compute_alpha.backendServices.html | 35 + .../compute_alpha.instanceGroupManagers.html | 12 +- ...te_alpha.interconnectAttachmentGroups.html | 59 + .../dyn/compute_alpha.interconnectGroups.html | 125 ++ docs/dyn/compute_alpha.machineImages.html | 24 + docs/dyn/compute_alpha.networkProfiles.html | 2 - .../compute_alpha.regionBackendServices.html | 30 + docs/dyn/compute_alpha.regionCommitments.html | 236 +-- ...ute_alpha.regionInstanceGroupManagers.html | 10 +- .../compute_alpha.regionSnapshotSettings.html | 2 + docs/dyn/compute_alpha.resourcePolicies.html | 15 + docs/dyn/compute_alpha.routers.html | 16 +- docs/dyn/compute_alpha.snapshotSettings.html | 2 + docs/dyn/compute_alpha.vpnTunnels.html | 108 ++ docs/dyn/compute_beta.advice.html | 170 ++ docs/dyn/compute_beta.html | 5 + .../compute_beta.instanceGroupManagers.html | 6 + docs/dyn/compute_beta.interconnects.html | 12 + docs/dyn/compute_beta.networkProfiles.html | 2 - docs/dyn/compute_beta.nodeTypes.html | 3 + docs/dyn/compute_beta.regionCommitments.html | 236 +-- ...pute_beta.regionInstanceGroupManagers.html | 5 + docs/dyn/compute_beta.reservationBlocks.html | 136 ++ docs/dyn/compute_beta.reservations.html | 135 ++ docs/dyn/compute_beta.routers.html | 16 +- docs/dyn/compute_v1.firewallPolicies.html | 292 ++++ docs/dyn/compute_v1.instances.html | 73 + .../compute_v1.networkFirewallPolicies.html | 1396 ++++++++++++++--- docs/dyn/compute_v1.networkProfiles.html | 2 - docs/dyn/compute_v1.networks.html | 73 + docs/dyn/compute_v1.nodeTypes.html | 3 + docs/dyn/compute_v1.regionCommitments.html | 228 +-- ...pute_v1.regionNetworkFirewallPolicies.html | 365 +++++ docs/dyn/compute_v1.routers.html | 16 +- .../documents/compute.alpha.json | 487 +++++- .../documents/compute.beta.json | 599 ++++++- .../discovery_cache/documents/compute.v1.json | 280 +++- 37 files changed, 4517 insertions(+), 699 deletions(-) create mode 100644 docs/dyn/compute_beta.advice.html diff --git a/docs/dyn/compute_alpha.backendServices.html b/docs/dyn/compute_alpha.backendServices.html index 4a7fdd05c07..44d8389109b 100644 --- a/docs/dyn/compute_alpha.backendServices.html +++ b/docs/dyn/compute_alpha.backendServices.html @@ -411,6 +411,11 @@

Method Details

"A String", ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the backend service with dynamic forwarding feature which together with Service Extension allows customized and complex routing logic. + "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend service. Some ranges are restricted: Restricted ranges. # IP:PORT based dynamic forwarding configuration. + "enabled": True or False, # A boolean flag enabling IP:PORT based dynamic forwarding. + }, + }, "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. @@ -1203,6 +1208,11 @@

Method Details

"A String", ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the backend service with dynamic forwarding feature which together with Service Extension allows customized and complex routing logic. + "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend service. Some ranges are restricted: Restricted ranges. # IP:PORT based dynamic forwarding configuration. + "enabled": True or False, # A boolean flag enabling IP:PORT based dynamic forwarding. + }, + }, "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. @@ -2073,6 +2083,11 @@

Method Details

"A String", ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the backend service with dynamic forwarding feature which together with Service Extension allows customized and complex routing logic. + "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend service. Some ranges are restricted: Restricted ranges. # IP:PORT based dynamic forwarding configuration. + "enabled": True or False, # A boolean flag enabling IP:PORT based dynamic forwarding. + }, + }, "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. @@ -2689,6 +2704,11 @@

Method Details

"A String", ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the backend service with dynamic forwarding feature which together with Service Extension allows customized and complex routing logic. + "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend service. Some ranges are restricted: Restricted ranges. # IP:PORT based dynamic forwarding configuration. + "enabled": True or False, # A boolean flag enabling IP:PORT based dynamic forwarding. + }, + }, "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. @@ -3203,6 +3223,11 @@

Method Details

"A String", ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the backend service with dynamic forwarding feature which together with Service Extension allows customized and complex routing logic. + "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend service. Some ranges are restricted: Restricted ranges. # IP:PORT based dynamic forwarding configuration. + "enabled": True or False, # A boolean flag enabling IP:PORT based dynamic forwarding. + }, + }, "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. @@ -3733,6 +3758,11 @@

Method Details

"A String", ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the backend service with dynamic forwarding feature which together with Service Extension allows customized and complex routing logic. + "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend service. Some ranges are restricted: Restricted ranges. # IP:PORT based dynamic forwarding configuration. + "enabled": True or False, # A boolean flag enabling IP:PORT based dynamic forwarding. + }, + }, "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. @@ -4732,6 +4762,11 @@

Method Details

"A String", ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the backend service with dynamic forwarding feature which together with Service Extension allows customized and complex routing logic. + "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend service. Some ranges are restricted: Restricted ranges. # IP:PORT based dynamic forwarding configuration. + "enabled": True or False, # A boolean flag enabling IP:PORT based dynamic forwarding. + }, + }, "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. diff --git a/docs/dyn/compute_alpha.instanceGroupManagers.html b/docs/dyn/compute_alpha.instanceGroupManagers.html index b98c5c01f81..9b77c779067 100644 --- a/docs/dyn/compute_alpha.instanceGroupManagers.html +++ b/docs/dyn/compute_alpha.instanceGroupManagers.html @@ -423,7 +423,7 @@

Method Details

"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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. @@ -1439,7 +1439,7 @@

Method Details

"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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. @@ -1694,7 +1694,7 @@

Method Details

"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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. @@ -2079,7 +2079,7 @@

Method Details

"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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. @@ -2691,7 +2691,7 @@

Method Details

"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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. @@ -4618,7 +4618,7 @@

Method Details

"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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. diff --git a/docs/dyn/compute_alpha.interconnectAttachmentGroups.html b/docs/dyn/compute_alpha.interconnectAttachmentGroups.html index fc4c2b23c6f..8e34d472f86 100644 --- a/docs/dyn/compute_alpha.interconnectAttachmentGroups.html +++ b/docs/dyn/compute_alpha.interconnectAttachmentGroups.html @@ -389,7 +389,66 @@

Method Details

{ # Response for the InterconnectAttachmentGroupsGetOperationalStatusResponse. "etag": "A String", "result": { + "attachmentStatuses": [ + { # The status of one Attachment in the group. List order is arbitrary. + "adminEnabled": True or False, # Whether this Attachment is enabled. This becomes false when the customer drains their Attachment. + "attachment": "A String", # The URL of the Attachment being described. + "isActive": "A String", # Whether this Attachment is participating in the redundant configuration. This will be ACTIVE if and only if the status below is CONNECTION_UP. Any INACTIVE Attachments are excluded from the analysis that generates operational.availabilitySLA. + "status": "A String", # Whether this Attachment is active, and if so, whether BGP is up. This is based on the statuses available in the Pantheon UI here: http://google3/java/com/google/cloud/boq/clientapi/gce/hybrid/api/interconnect_models.proto + }, + ], + "configured": { # [Output Only] The redundancy this group is configured to support. The way a user queries what SLA their Attachment gets is by looking at this field of the Attachment's AttachmentGroup. + "availabilitySla": { # [Output Only] Which SLA this group is configured to support, and why this group does or does not meet that SLA's requirements. + "effectiveSla": "A String", + "intendedSlaBlockers": [ + { # [Output Only] Reasons why configuration.availabilitySLA.sla differs from intent.availabilitySLA. This list is empty if and only if those are the same. + "attachments": [ # [Output Only] URLs of any particular Attachments to explain this blocker in more detail. + "A String", + ], + "blockerType": "A String", + "documentationLink": "A String", # [Output Only] The url of Google Cloud public documentation explaining this requirement. This is set for every type of requirement. + "explanation": "A String", # [Output Only] A human-readable explanation of this requirement and why it's not met. This is set for every type of requirement. + "metros": [ # [Output Only] Metros used to explain this blocker in more detail. These are three-letter lowercase strings like "iad". This will be set for some blockers (like NO_ATTACHMENTS_IN_METRO_AND_ZONE) but does not apply to others. + "A String", + ], + "regions": [ # [Output Only] Regions used to explain this blocker in more detail. These are region names formatted like "us-central1". This will be set for some blockers (like INCOMPATIBLE_REGIONS) but does not apply to others. + "A String", + ], + "zones": [ # [Output Only] Zones used to explain this blocker in more detail. Format is "zone1" and/or "zone2". This will be set for some blockers (like MISSING_ZONE) but does not apply to others. + "A String", + ], + }, + ], + }, + }, "groupStatus": "A String", # Summarizes the status of the group. + "intent": { # The user's intent for this AttachmentGroup. This is the only required field besides the name that must be specified on group creation. + "availabilitySla": "A String", + }, + "operational": { # [Output Only] The redundancy this group is configured to support. The way a user queries what SLA their Attachment gets is by looking at this field of the Attachment's AttachmentGroup. # The operational state of the group, including only active Attachments. + "availabilitySla": { # [Output Only] Which SLA this group is configured to support, and why this group does or does not meet that SLA's requirements. + "effectiveSla": "A String", + "intendedSlaBlockers": [ + { # [Output Only] Reasons why configuration.availabilitySLA.sla differs from intent.availabilitySLA. This list is empty if and only if those are the same. + "attachments": [ # [Output Only] URLs of any particular Attachments to explain this blocker in more detail. + "A String", + ], + "blockerType": "A String", + "documentationLink": "A String", # [Output Only] The url of Google Cloud public documentation explaining this requirement. This is set for every type of requirement. + "explanation": "A String", # [Output Only] A human-readable explanation of this requirement and why it's not met. This is set for every type of requirement. + "metros": [ # [Output Only] Metros used to explain this blocker in more detail. These are three-letter lowercase strings like "iad". This will be set for some blockers (like NO_ATTACHMENTS_IN_METRO_AND_ZONE) but does not apply to others. + "A String", + ], + "regions": [ # [Output Only] Regions used to explain this blocker in more detail. These are region names formatted like "us-central1". This will be set for some blockers (like INCOMPATIBLE_REGIONS) but does not apply to others. + "A String", + ], + "zones": [ # [Output Only] Zones used to explain this blocker in more detail. Format is "zone1" and/or "zone2". This will be set for some blockers (like MISSING_ZONE) but does not apply to others. + "A String", + ], + }, + ], + }, + }, }, } diff --git a/docs/dyn/compute_alpha.interconnectGroups.html b/docs/dyn/compute_alpha.interconnectGroups.html index 11001523e21..292f5be66f7 100644 --- a/docs/dyn/compute_alpha.interconnectGroups.html +++ b/docs/dyn/compute_alpha.interconnectGroups.html @@ -77,6 +77,9 @@

Instance Methods

close()

Close httplib2 connections.

+

+ createMembers(project, interconnectGroup, body=None, x__xgafv=None)

+

Create Interconnects with redundancy by creating them in a specified interconnect group.

delete(project, interconnectGroup, requestId=None, x__xgafv=None)

Deletes the specified InterconnectGroup in the given scope

@@ -113,6 +116,128 @@

Method Details

Close httplib2 connections.
+
+ createMembers(project, interconnectGroup, body=None, x__xgafv=None) +
Create Interconnects with redundancy by creating them in a specified interconnect group.
+
+Args:
+  project: string, Project ID for this request. (required)
+  interconnectGroup: string, Name of the group resource to create members for. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "request": {
+    "intentMismatchBehavior": "A String", # How to behave when configured.topologyCapability.supportedSLA would not equal intent.topologyCapability after this call.
+    "interconnects": [
+      { # LINT.IfChange
+        "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.
+        "customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
+        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+        "facility": "A String", # A zone-free location to use for all Interconnects created in this call, like "iad-1234".
+        "interconnectType": "A String", # Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
+        "linkType": "A String", # Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.
+        "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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.
+        "nocContactEmail": "A String", # Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.
+        "remoteLocation": "A String", # Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.
+        "requestedFeatures": [ # Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.
+          "A String",
+        ],
+        "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer.
+      },
+    ],
+    "templateInterconnect": { # LINT.IfChange # Parameters for the Interconnects to create.
+      "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.
+      "customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+      "facility": "A String", # A zone-free location to use for all Interconnects created in this call, like "iad-1234".
+      "interconnectType": "A String", # Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
+      "linkType": "A String", # Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.
+      "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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.
+      "nocContactEmail": "A String", # Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.
+      "remoteLocation": "A String", # Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.
+      "requestedFeatures": [ # Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.
+        "A String",
+      ],
+      "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer.
+    },
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for the InterconnectGroupsCreateMembersRequest.
+  "etag": "A String",
+  "result": { # An interconnect group resource allows customers to create, analyze, and expand their redundant connections.
+    "configured": { # [Output Only] The status of the group as configured. This has the same structure as the operational field reported by the OperationalStatus method, but does not take into account the operational status of each resource.
+      "topologyCapability": { # [Output Only] How reliable this topology is configured to be, and why this group does or does not meet the requirements for the intended capability.
+        "intendedCapabilityBlockers": [
+          { # [Output Only] Reasons why configuration.topologyCapability.sla differs from intent.topologyCapability. This list is empty if and only if those are the same.
+            "blockerType": "A String",
+            "documentationLink": "A String", # [Output Only] The url of Google Cloud public documentation explaining this requirement. This is set for every type of requirement.
+            "explanation": "A String", # [Output Only] A human-readable explanation of this requirement and why it's not met. This is set for every type of requirement.
+            "facilities": [ # [Output Only] Facilities used to explain this blocker in more detail. Like physicalStructure.metros.facilities.facility, this is a numeric string like "5467".
+              "A String",
+            ],
+            "interconnects": [ # [Output Only] Interconnects used to explain this blocker in more detail.
+              "A String",
+            ],
+            "metros": [ # [Output Only] Metros used to explain this blocker in more detail. These are three-letter lowercase strings like "iad". A blocker like INCOMPATIBLE_METROS will specify the problematic metros in this field.
+              "A String",
+            ],
+            "zones": [ # [Output Only] Zones used to explain this blocker in more detail. Zone names are "zone1" and/or "zone2".
+              "A String",
+            ],
+          },
+        ],
+        "supportedSla": "A String",
+      },
+    },
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+    "etag": "A String", # Opaque system-generated token that uniquely identifies the configuration. If provided when patching a configuration in update mode, the provided token must match the current token or the update is rejected. This provides a reliable means of doing read-modify-write (optimistic locking) as described by API 154.
+    "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.
+    "intent": { # The user's intent for this group. This is the only required field besides the name that must be specified on group creation.
+      "topologyCapability": "A String",
+    },
+    "interconnects": { # Interconnects in the InterconnectGroup. Keys are arbitrary user-specified strings. Users are encouraged, but not required, to use their preferred format for resource links as keys. Note that there are add-members and remove-members methods in gcloud. The size of this map is limited by an "Interconnects per group" quota.
+      "a_key": { # An Interconnect in this InterconnectGroup.
+        "interconnect": "A String", # The URL of an Interconnect in this group. All Interconnects in the group are unique.
+      },
+    },
+    "kind": "compute#InterconnectGroup", # [Output Only] Type of the resource. Always compute#InterconnectGroup
+    "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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.
+    "physicalStructure": { # [Output Only] An analysis of the physical layout of Interconnects in this group. Every Interconnect in the group is shown once in this structure.
+      "metros": [
+        { # [Output Only] The metros Interconnects in this group are in.
+          "facilities": [
+            { # [Output Only] The facilities Interconnects in this metro are present in.
+              "facility": "A String", # [Output Only] The ID of this facility, as a numeric string like "5467". This is the third component of the location of Interconnects in this facility.
+              "zones": [
+                { # [Output Only] The zones that Interconnects in this facility are present in.
+                  "interconnects": [ # [Output Only] URLs of Interconnects in this redundancy group in the given metro, facility, and zone.
+                    "A String",
+                  ],
+                  "zone": "A String", # [Output Only] The name of the zone, either "zone1" or "zone2". This is the second component of the location of Interconnects in this facility.
+                },
+              ],
+            },
+          ],
+          "metro": "A String", # [Output Only] The name of the metro, as a three-letter lowercase string like "iad". This is the first component of the location of Interconnects underneath this.
+        },
+      ],
+    },
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  },
+}
+
+
delete(project, interconnectGroup, requestId=None, x__xgafv=None)
Deletes the specified InterconnectGroup in the given scope
diff --git a/docs/dyn/compute_alpha.machineImages.html b/docs/dyn/compute_alpha.machineImages.html
index 3dff8b5853f..405e0f4398f 100644
--- a/docs/dyn/compute_alpha.machineImages.html
+++ b/docs/dyn/compute_alpha.machineImages.html
@@ -593,6 +593,14 @@ 

Method Details

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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": { # Machine Image parameters # Input only. [Input Only] Additional parameters that are passed in the request, but are not persisted in the resource. + "excludedDisks": [ # Input only. [Input Only] Specifies the list of disk device names that must be excluded from the new machine image. + "A String", + ], + "includedDisks": [ # Input only. [Input Only] Specifies the list of disk device names that must be included with the new machine image. + "A String", + ], + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "savedDisks": [ # An array of Machine Image specific properties for disks attached to the source instance @@ -1220,6 +1228,14 @@

Method Details

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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": { # Machine Image parameters # Input only. [Input Only] Additional parameters that are passed in the request, but are not persisted in the resource. + "excludedDisks": [ # Input only. [Input Only] Specifies the list of disk device names that must be excluded from the new machine image. + "A String", + ], + "includedDisks": [ # Input only. [Input Only] Specifies the list of disk device names that must be included with the new machine image. + "A String", + ], + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "savedDisks": [ # An array of Machine Image specific properties for disks attached to the source instance @@ -1929,6 +1945,14 @@

Method Details

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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": { # Machine Image parameters # Input only. [Input Only] Additional parameters that are passed in the request, but are not persisted in the resource. + "excludedDisks": [ # Input only. [Input Only] Specifies the list of disk device names that must be excluded from the new machine image. + "A String", + ], + "includedDisks": [ # Input only. [Input Only] Specifies the list of disk device names that must be included with the new machine image. + "A String", + ], + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "savedDisks": [ # An array of Machine Image specific properties for disks attached to the source instance diff --git a/docs/dyn/compute_alpha.networkProfiles.html b/docs/dyn/compute_alpha.networkProfiles.html index 978f87aee8d..403dc528d8d 100644 --- a/docs/dyn/compute_alpha.networkProfiles.html +++ b/docs/dyn/compute_alpha.networkProfiles.html @@ -151,7 +151,6 @@

Method Details

"name": "A String", # [Output Only] Name of the resource. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. - "zone": "A String", # [Output Only] Zone to which the network is restricted. }
@@ -222,7 +221,6 @@

Method Details

"name": "A String", # [Output Only] Name of the resource. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. - "zone": "A String", # [Output Only] Zone to which the network is restricted. }, ], "kind": "compute#networkProfileList", # [Output Only] Type of resource. Always compute#networkProfileList for network profiles. diff --git a/docs/dyn/compute_alpha.regionBackendServices.html b/docs/dyn/compute_alpha.regionBackendServices.html index 8398344adc4..dcc73808c6b 100644 --- a/docs/dyn/compute_alpha.regionBackendServices.html +++ b/docs/dyn/compute_alpha.regionBackendServices.html @@ -381,6 +381,11 @@

Method Details

"A String", ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the backend service with dynamic forwarding feature which together with Service Extension allows customized and complex routing logic. + "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend service. Some ranges are restricted: Restricted ranges. # IP:PORT based dynamic forwarding configuration. + "enabled": True or False, # A boolean flag enabling IP:PORT based dynamic forwarding. + }, + }, "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. @@ -966,6 +971,11 @@

Method Details

"A String", ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the backend service with dynamic forwarding feature which together with Service Extension allows customized and complex routing logic. + "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend service. Some ranges are restricted: Restricted ranges. # IP:PORT based dynamic forwarding configuration. + "enabled": True or False, # A boolean flag enabling IP:PORT based dynamic forwarding. + }, + }, "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. @@ -1583,6 +1593,11 @@

Method Details

"A String", ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the backend service with dynamic forwarding feature which together with Service Extension allows customized and complex routing logic. + "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend service. Some ranges are restricted: Restricted ranges. # IP:PORT based dynamic forwarding configuration. + "enabled": True or False, # A boolean flag enabling IP:PORT based dynamic forwarding. + }, + }, "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. @@ -2098,6 +2113,11 @@

Method Details

"A String", ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the backend service with dynamic forwarding feature which together with Service Extension allows customized and complex routing logic. + "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend service. Some ranges are restricted: Restricted ranges. # IP:PORT based dynamic forwarding configuration. + "enabled": True or False, # A boolean flag enabling IP:PORT based dynamic forwarding. + }, + }, "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. @@ -2629,6 +2649,11 @@

Method Details

"A String", ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the backend service with dynamic forwarding feature which together with Service Extension allows customized and complex routing logic. + "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend service. Some ranges are restricted: Restricted ranges. # IP:PORT based dynamic forwarding configuration. + "enabled": True or False, # A boolean flag enabling IP:PORT based dynamic forwarding. + }, + }, "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. @@ -3500,6 +3525,11 @@

Method Details

"A String", ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the backend service with dynamic forwarding feature which together with Service Extension allows customized and complex routing logic. + "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend service. Some ranges are restricted: Restricted ranges. # IP:PORT based dynamic forwarding configuration. + "enabled": True or False, # A boolean flag enabling IP:PORT based dynamic forwarding. + }, + }, "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. diff --git a/docs/dyn/compute_alpha.regionCommitments.html b/docs/dyn/compute_alpha.regionCommitments.html index dc19efb415c..33259eb9d7b 100644 --- a/docs/dyn/compute_alpha.regionCommitments.html +++ b/docs/dyn/compute_alpha.regionCommitments.html @@ -106,10 +106,10 @@

Instance Methods

Returns permissions that a caller has on the specified resource.

update(project, region, commitment, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)

-

Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.

+

Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be updated: auto_renew and plan.

updateReservations(project, region, commitment, body=None, requestId=None, x__xgafv=None)

-

Transfers GPUs or local SSDs between reservations within commitments.

+

Transfers GPUs or Local SSD disks between reservations that are attached to the same commitment.

Method Details

aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None) @@ -136,31 +136,31 @@

Method Details

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": { # A list of CommitmentsScopedList resources. "a_key": { # [Output Only] Name of the scope containing this set of commitments. - "commitments": [ # [Output Only] A list of commitments contained in this scope. - { # Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. - "autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. - "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. + "commitments": [ # [Output Only] The list of commitments contained in this scope. + { # Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts + "autoRenew": True or False, # Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027. + "category": "A String", # The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. - "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "customEndTimestamp": "A String", # [Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration. + "description": "A String", # An optional description of the commitment. You can provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. - "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation + "existingReservations": [ "A String", ], "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments. "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment. - "amount": "A String", # The number of licenses purchased. - "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies. - "license": "A String", # Any applicable license URI. + "amount": "A String", # The number of licenses you plan to purchase. + "coresPerLicense": "A String", # The number of cores per license. + "license": "A String", # The applicable license URI. }, - "mergeSourceCommitments": [ # List of source commitments to be merged into a new commitment. + "mergeSourceCommitments": [ # The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments. "A String", ], - "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. - "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). - "region": "A String", # [Output Only] URL of the region where this commitment may be used. - "reservations": [ # List of create-on-create reservations for this commitment. + "name": "A String", # Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. + "plan": "A String", # The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). + "region": "A String", # [Output Only] URL of the region where the commitment and committed resources are located. + "reservations": [ # The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead. { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. "aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility. "inUseResources": [ # [Output only] List of resources currently in use. @@ -299,20 +299,20 @@

Method Details

}, "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, - "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. - { # Commitment for a particular resource (a Commitment is composed of one or more of these). - "acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. - "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. - "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. + "resources": [ # The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type. + { # Commitment for a particular hardware resource (a commitment is composed of one or more of these). + "acceleratorType": "A String", # Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR. + "amount": "A String", # The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. + "type": "A String", # The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type. }, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. - "splitSourceCommitment": "A String", # Source commitment to be split into a new commitment. + "splitSourceCommitment": "A String", # The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments. "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format. - "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. - "type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. + "type": "A String", # The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. }, ], "warning": { # [Output Only] Informational warning which replaces the list of commitments when the list is empty. @@ -633,30 +633,30 @@

Method Details

Returns: An object of the form: - { # Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. - "autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. - "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. + { # Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts + "autoRenew": True or False, # Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027. + "category": "A String", # The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. - "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "customEndTimestamp": "A String", # [Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration. + "description": "A String", # An optional description of the commitment. You can provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. - "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation + "existingReservations": [ "A String", ], "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments. "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment. - "amount": "A String", # The number of licenses purchased. - "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies. - "license": "A String", # Any applicable license URI. + "amount": "A String", # The number of licenses you plan to purchase. + "coresPerLicense": "A String", # The number of cores per license. + "license": "A String", # The applicable license URI. }, - "mergeSourceCommitments": [ # List of source commitments to be merged into a new commitment. + "mergeSourceCommitments": [ # The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments. "A String", ], - "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. - "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). - "region": "A String", # [Output Only] URL of the region where this commitment may be used. - "reservations": [ # List of create-on-create reservations for this commitment. + "name": "A String", # Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. + "plan": "A String", # The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). + "region": "A String", # [Output Only] URL of the region where the commitment and committed resources are located. + "reservations": [ # The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead. { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. "aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility. "inUseResources": [ # [Output only] List of resources currently in use. @@ -795,20 +795,20 @@

Method Details

}, "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, - "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. - { # Commitment for a particular resource (a Commitment is composed of one or more of these). - "acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. - "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. - "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. + "resources": [ # The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type. + { # Commitment for a particular hardware resource (a commitment is composed of one or more of these). + "acceleratorType": "A String", # Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR. + "amount": "A String", # The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. + "type": "A String", # The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type. }, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. - "splitSourceCommitment": "A String", # Source commitment to be split into a new commitment. + "splitSourceCommitment": "A String", # The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments. "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format. - "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. - "type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. + "type": "A String", # The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. }
@@ -822,30 +822,30 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. - "autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. - "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. +{ # Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts + "autoRenew": True or False, # Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027. + "category": "A String", # The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. - "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "customEndTimestamp": "A String", # [Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration. + "description": "A String", # An optional description of the commitment. You can provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. - "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation + "existingReservations": [ "A String", ], "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments. "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment. - "amount": "A String", # The number of licenses purchased. - "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies. - "license": "A String", # Any applicable license URI. + "amount": "A String", # The number of licenses you plan to purchase. + "coresPerLicense": "A String", # The number of cores per license. + "license": "A String", # The applicable license URI. }, - "mergeSourceCommitments": [ # List of source commitments to be merged into a new commitment. + "mergeSourceCommitments": [ # The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments. "A String", ], - "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. - "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). - "region": "A String", # [Output Only] URL of the region where this commitment may be used. - "reservations": [ # List of create-on-create reservations for this commitment. + "name": "A String", # Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. + "plan": "A String", # The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). + "region": "A String", # [Output Only] URL of the region where the commitment and committed resources are located. + "reservations": [ # The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead. { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. "aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility. "inUseResources": [ # [Output only] List of resources currently in use. @@ -984,20 +984,20 @@

Method Details

}, "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, - "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. - { # Commitment for a particular resource (a Commitment is composed of one or more of these). - "acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. - "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. - "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. + "resources": [ # The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type. + { # Commitment for a particular hardware resource (a commitment is composed of one or more of these). + "acceleratorType": "A String", # Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR. + "amount": "A String", # The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. + "type": "A String", # The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type. }, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. - "splitSourceCommitment": "A String", # Source commitment to be split into a new commitment. + "splitSourceCommitment": "A String", # The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments. "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format. - "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. - "type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. + "type": "A String", # The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. } 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). @@ -1141,30 +1141,30 @@

Method Details

{ # Contains a list of Commitment resources. "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of Commitment resources. - { # Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. - "autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. - "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. + { # Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts + "autoRenew": True or False, # Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027. + "category": "A String", # The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. - "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "customEndTimestamp": "A String", # [Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration. + "description": "A String", # An optional description of the commitment. You can provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. - "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation + "existingReservations": [ "A String", ], "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments. "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment. - "amount": "A String", # The number of licenses purchased. - "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies. - "license": "A String", # Any applicable license URI. + "amount": "A String", # The number of licenses you plan to purchase. + "coresPerLicense": "A String", # The number of cores per license. + "license": "A String", # The applicable license URI. }, - "mergeSourceCommitments": [ # List of source commitments to be merged into a new commitment. + "mergeSourceCommitments": [ # The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments. "A String", ], - "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. - "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). - "region": "A String", # [Output Only] URL of the region where this commitment may be used. - "reservations": [ # List of create-on-create reservations for this commitment. + "name": "A String", # Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. + "plan": "A String", # The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). + "region": "A String", # [Output Only] URL of the region where the commitment and committed resources are located. + "reservations": [ # The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead. { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. "aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility. "inUseResources": [ # [Output only] List of resources currently in use. @@ -1303,20 +1303,20 @@

Method Details

}, "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, - "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. - { # Commitment for a particular resource (a Commitment is composed of one or more of these). - "acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. - "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. - "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. + "resources": [ # The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type. + { # Commitment for a particular hardware resource (a commitment is composed of one or more of these). + "acceleratorType": "A String", # Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR. + "amount": "A String", # The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. + "type": "A String", # The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type. }, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. - "splitSourceCommitment": "A String", # Source commitment to be split into a new commitment. + "splitSourceCommitment": "A String", # The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments. "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format. - "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. - "type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. + "type": "A String", # The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. }, ], "kind": "compute#commitmentList", # [Output Only] Type of resource. Always compute#commitmentList for lists of commitments. @@ -1383,39 +1383,39 @@

Method Details

update(project, region, commitment, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None) -
Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.
+  
Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be updated: auto_renew and plan.
 
 Args:
   project: string, Project ID for this request. (required)
   region: string, Name of the region for this request. (required)
-  commitment: string, Name of the commitment for which auto renew is being updated. (required)
+  commitment: string, Name of the commitment that you want to update. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts.
-  "autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.
-  "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.
+{ # Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts
+  "autoRenew": True or False, # Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027.
+  "category": "A String", # The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to.
   "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-  "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.
-  "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+  "customEndTimestamp": "A String", # [Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration.
+  "description": "A String", # An optional description of the commitment. You can provide this property when you create the resource.
   "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.
-  "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation
+  "existingReservations": [
     "A String",
   ],
   "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
   "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments.
   "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment.
-    "amount": "A String", # The number of licenses purchased.
-    "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies.
-    "license": "A String", # Any applicable license URI.
+    "amount": "A String", # The number of licenses you plan to purchase.
+    "coresPerLicense": "A String", # The number of cores per license.
+    "license": "A String", # The applicable license URI.
   },
-  "mergeSourceCommitments": [ # List of source commitments to be merged into a new commitment.
+  "mergeSourceCommitments": [ # The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.
     "A String",
   ],
-  "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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.
-  "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
-  "region": "A String", # [Output Only] URL of the region where this commitment may be used.
-  "reservations": [ # List of create-on-create reservations for this commitment.
+  "name": "A String", # Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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.
+  "plan": "A String", # The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
+  "region": "A String", # [Output Only] URL of the region where the commitment and committed resources are located.
+  "reservations": [ # The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
     { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.
       "aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility.
         "inUseResources": [ # [Output only] List of resources currently in use.
@@ -1554,20 +1554,20 @@ 

Method Details

}, "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, - "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. - { # Commitment for a particular resource (a Commitment is composed of one or more of these). - "acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. - "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. - "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. + "resources": [ # The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type. + { # Commitment for a particular hardware resource (a commitment is composed of one or more of these). + "acceleratorType": "A String", # Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR. + "amount": "A String", # The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. + "type": "A String", # The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type. }, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. - "splitSourceCommitment": "A String", # Source commitment to be split into a new commitment. + "splitSourceCommitment": "A String", # The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments. "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format. - "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. - "type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. + "type": "A String", # The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. } paths: string, A parameter (repeated) @@ -1692,17 +1692,17 @@

Method Details

updateReservations(project, region, commitment, body=None, requestId=None, x__xgafv=None) -
Transfers GPUs or local SSDs between reservations within commitments.
+  
Transfers GPUs or Local SSD disks between reservations that are attached to the same commitment.
 
 Args:
   project: string, Project ID for this request. (required)
   region: string, Name of the region for this request. (required)
-  commitment: string, Name of the commitment for which the reservation is being updated. (required)
+  commitment: string, Name of the commitment for which the reservations are being updated. (required)
   body: object, The request body.
     The object takes the form of:
 
 {
-  "reservations": [ # A list of two reservations to transfer GPUs and local SSD between.
+  "reservations": [ # A list of two reservations to transfer GPUs and Local SSD disks between.
     { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.
       "aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility.
         "inUseResources": [ # [Output only] List of resources currently in use.
diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html
index da72dc3ee87..2796b1f4482 100644
--- a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html
+++ b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html
@@ -1115,7 +1115,7 @@ 

Method Details

"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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. @@ -1370,7 +1370,7 @@

Method Details

"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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. @@ -1755,7 +1755,7 @@

Method Details

"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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. @@ -2367,7 +2367,7 @@

Method Details

"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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. @@ -4294,7 +4294,7 @@

Method Details

"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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. diff --git a/docs/dyn/compute_alpha.regionSnapshotSettings.html b/docs/dyn/compute_alpha.regionSnapshotSettings.html index c0dd8f7993f..94f474276f4 100644 --- a/docs/dyn/compute_alpha.regionSnapshotSettings.html +++ b/docs/dyn/compute_alpha.regionSnapshotSettings.html @@ -111,6 +111,7 @@

Method Details

"region": "A String", # Accessible region name }, }, + "policy": "A String", # Policy of which location is allowed to access snapshot. }, "storageLocation": { # Policy of which storage location is going to be resolved, and additional data that particularizes how the policy is going to be carried out. "locations": { # When the policy is SPECIFIC_LOCATIONS, snapshots will be stored in the locations listed in this field. Keys are Cloud Storage bucket locations. Only one location can be specified. @@ -140,6 +141,7 @@

Method Details

"region": "A String", # Accessible region name }, }, + "policy": "A String", # Policy of which location is allowed to access snapshot. }, "storageLocation": { # Policy of which storage location is going to be resolved, and additional data that particularizes how the policy is going to be carried out. "locations": { # When the policy is SPECIFIC_LOCATIONS, snapshots will be stored in the locations listed in this field. Keys are Cloud Storage bucket locations. Only one location can be specified. diff --git a/docs/dyn/compute_alpha.resourcePolicies.html b/docs/dyn/compute_alpha.resourcePolicies.html index 017fd7da5f9..a54237138cd 100644 --- a/docs/dyn/compute_alpha.resourcePolicies.html +++ b/docs/dyn/compute_alpha.resourcePolicies.html @@ -209,6 +209,7 @@

Method Details

"labels": { # Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty. "a_key": "A String", }, + "region": "A String", # Region where the snapshot is scoped to. "storageLocations": [ # Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional). "A String", ], @@ -228,6 +229,8 @@

Method Details

}, }, "workloadPolicy": { # Represents the workload policy. + "acceleratorTopology": "A String", + "maxTopologyDistance": "A String", "type": "A String", }, }, @@ -495,6 +498,7 @@

Method Details

"labels": { # Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty. "a_key": "A String", }, + "region": "A String", # Region where the snapshot is scoped to. "storageLocations": [ # Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional). "A String", ], @@ -514,6 +518,8 @@

Method Details

}, }, "workloadPolicy": { # Represents the workload policy. + "acceleratorTopology": "A String", + "maxTopologyDistance": "A String", "type": "A String", }, }
@@ -650,6 +656,7 @@

Method Details

"labels": { # Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty. "a_key": "A String", }, + "region": "A String", # Region where the snapshot is scoped to. "storageLocations": [ # Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional). "A String", ], @@ -669,6 +676,8 @@

Method Details

}, }, "workloadPolicy": { # Represents the workload policy. + "acceleratorTopology": "A String", + "maxTopologyDistance": "A String", "type": "A String", }, } @@ -886,6 +895,7 @@

Method Details

"labels": { # Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty. "a_key": "A String", }, + "region": "A String", # Region where the snapshot is scoped to. "storageLocations": [ # Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional). "A String", ], @@ -905,6 +915,8 @@

Method Details

}, }, "workloadPolicy": { # Represents the workload policy. + "acceleratorTopology": "A String", + "maxTopologyDistance": "A String", "type": "A String", }, }, @@ -1021,6 +1033,7 @@

Method Details

"labels": { # Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty. "a_key": "A String", }, + "region": "A String", # Region where the snapshot is scoped to. "storageLocations": [ # Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional). "A String", ], @@ -1040,6 +1053,8 @@

Method Details

}, }, "workloadPolicy": { # Represents the workload policy. + "acceleratorTopology": "A String", + "maxTopologyDistance": "A String", "type": "A String", }, } diff --git a/docs/dyn/compute_alpha.routers.html b/docs/dyn/compute_alpha.routers.html index dc8dc03ef40..327b2fbc430 100644 --- a/docs/dyn/compute_alpha.routers.html +++ b/docs/dyn/compute_alpha.routers.html @@ -264,7 +264,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. @@ -878,7 +878,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. @@ -1576,7 +1576,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. @@ -1885,7 +1885,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. @@ -2341,7 +2341,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. @@ -2936,7 +2936,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. @@ -3113,7 +3113,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. @@ -3326,7 +3326,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. diff --git a/docs/dyn/compute_alpha.snapshotSettings.html b/docs/dyn/compute_alpha.snapshotSettings.html index 3d636bd18eb..fdec6dafaca 100644 --- a/docs/dyn/compute_alpha.snapshotSettings.html +++ b/docs/dyn/compute_alpha.snapshotSettings.html @@ -110,6 +110,7 @@

Method Details

"region": "A String", # Accessible region name }, }, + "policy": "A String", # Policy of which location is allowed to access snapshot. }, "storageLocation": { # Policy of which storage location is going to be resolved, and additional data that particularizes how the policy is going to be carried out. "locations": { # When the policy is SPECIFIC_LOCATIONS, snapshots will be stored in the locations listed in this field. Keys are Cloud Storage bucket locations. Only one location can be specified. @@ -138,6 +139,7 @@

Method Details

"region": "A String", # Accessible region name }, }, + "policy": "A String", # Policy of which location is allowed to access snapshot. }, "storageLocation": { # Policy of which storage location is going to be resolved, and additional data that particularizes how the policy is going to be carried out. "locations": { # When the policy is SPECIFIC_LOCATIONS, snapshots will be stored in the locations listed in this field. Keys are Cloud Storage bucket locations. Only one location can be specified. diff --git a/docs/dyn/compute_alpha.vpnTunnels.html b/docs/dyn/compute_alpha.vpnTunnels.html index f24dc0df729..ec99d34024a 100644 --- a/docs/dyn/compute_alpha.vpnTunnels.html +++ b/docs/dyn/compute_alpha.vpnTunnels.html @@ -132,6 +132,33 @@

Method Details

"a_key": { # Name of the scope containing this set of VPN tunnels. "vpnTunnels": [ # A list of VPN tunnels contained in this scope. { # Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. + "cipherSuite": { # User specified list of ciphers to use for the phase 1 and phase 2 of the IKE protocol. + "phase1": { + "dh": [ + "A String", + ], + "encryption": [ + "A String", + ], + "integrity": [ + "A String", + ], + "prf": [ + "A String", + ], + }, + "phase2": { + "encryption": [ + "A String", + ], + "integrity": [ + "A String", + ], + "pfs": [ + "A String", + ], + }, + }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel. @@ -357,6 +384,33 @@

Method Details

An object of the form: { # Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. + "cipherSuite": { # User specified list of ciphers to use for the phase 1 and phase 2 of the IKE protocol. + "phase1": { + "dh": [ + "A String", + ], + "encryption": [ + "A String", + ], + "integrity": [ + "A String", + ], + "prf": [ + "A String", + ], + }, + "phase2": { + "encryption": [ + "A String", + ], + "integrity": [ + "A String", + ], + "pfs": [ + "A String", + ], + }, + }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel. @@ -401,6 +455,33 @@

Method Details

The object takes the form of: { # Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. + "cipherSuite": { # User specified list of ciphers to use for the phase 1 and phase 2 of the IKE protocol. + "phase1": { + "dh": [ + "A String", + ], + "encryption": [ + "A String", + ], + "integrity": [ + "A String", + ], + "prf": [ + "A String", + ], + }, + "phase2": { + "encryption": [ + "A String", + ], + "integrity": [ + "A String", + ], + "pfs": [ + "A String", + ], + }, + }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel. @@ -575,6 +656,33 @@

Method Details

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of VpnTunnel resources. { # Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. + "cipherSuite": { # User specified list of ciphers to use for the phase 1 and phase 2 of the IKE protocol. + "phase1": { + "dh": [ + "A String", + ], + "encryption": [ + "A String", + ], + "integrity": [ + "A String", + ], + "prf": [ + "A String", + ], + }, + "phase2": { + "encryption": [ + "A String", + ], + "integrity": [ + "A String", + ], + "pfs": [ + "A String", + ], + }, + }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel. diff --git a/docs/dyn/compute_beta.advice.html b/docs/dyn/compute_beta.advice.html new file mode 100644 index 00000000000..c9a95cb0456 --- /dev/null +++ b/docs/dyn/compute_beta.advice.html @@ -0,0 +1,170 @@ + + + +

Compute Engine API . advice

+

Instance Methods

+

+ calendarMode(project, region, body=None, x__xgafv=None)

+

Advise how, where and when to create the requested amount of instances with specified accelerators, within the specified time and location limits. The method recommends creating future reservations for the requested resources.

+

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ calendarMode(project, region, body=None, x__xgafv=None) +
Advise how, where and when to create the requested amount of instances with specified accelerators, within the specified time and location limits. The method recommends creating future reservations for the requested resources.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A request to recommend the best way to consume the specified resources in the future.
+  "futureResourcesSpecs": { # Specification of resources to create in the future. The key of the map is an arbitrary string specified by the caller. Value of the map is a specification of required resources and their constraints. Currently only one value is allowed in this map.
+    "a_key": { # Specification of resources to be created at some time in the future within an optionally specified set of locations, and within the specified time range.
+      "deploymentType": "A String", # Indicates if the reservation allocation strategy is static (DENSE) or dynamic (STANDARD). Defaults to DENSE.
+      "locationPolicy": { # Specification of locations to create resources in. # Optional location policy allowing to exclude some zone(s) in which the resources must not be created.
+        "locations": { # Preferences for specified locations. Keys of the map are locations - zones, in format of 'zones/'. Values are preferences for the zones. If a zone is not specified in this map, it is ALLOWed.
+          "a_key": { # Preference for a single specified location.
+            "preference": "A String", # Preference for this location.
+          },
+        },
+      },
+      "targetResources": { # Specification of reserved resources. # Specification of the reserved resources.
+        "aggregateResources": {
+          "acceleratorCount": "A String", # Size of the request, in accelerator (chip) count.
+          "vmFamily": "A String", # The VM family that all instances scheduled against this reservation must belong to. Use for TPU reservations.
+          "workloadType": "A String", # Workload type. Use for TPU reservations.
+        },
+        "specificSkuResources": {
+          "instanceCount": "A String", # Size of the request, in instance count.
+          "localSsdPartitions": [ # Local SSD partitions. You do not have to include SSD partitions that are built in the machine type.
+            {
+              "diskInterface": "A String", # Disk interface. Defaults to SCSI.
+              "diskSizeGb": "A String", # The size of the disk in GB.
+            },
+          ],
+          "machineType": "A String", # The machine type to use for instances that will use the reservation. This field only accepts machine type names. e.g. n2-standard-4 and does not accept machine type full or partial url. e.g. projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4. Use for GPU reservations.
+        },
+      },
+      "timeRangeSpec": { # A flexible specification of a time range that has 3 points of flexibility: (1) a flexible start time, (2) a flexible end time, (3) a flexible duration. It is possible to specify a contradictory time range that cannot be matched by any Interval. This causes a validation error. # Specification of a time range in which the resources may be created. The time range specifies start of resource use and planned end of resource use.
+        "endTimeNotEarlierThan": "A String",
+        "endTimeNotLaterThan": "A String",
+        "maxDuration": "A String",
+        "minDuration": "A String",
+        "startTimeNotEarlierThan": "A String",
+        "startTimeNotLaterThan": "A String",
+      },
+    },
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A response containing the recommended way of creating the specified resources in the future. It contains (will contain) multiple recommendations that can be analyzed by the customer and the best one can be picked.
+  "recommendations": [ # Recommendations where, how and when to create the requested resources in order to maximize their obtainability and minimize cost.
+    { # A single recommendation to create requested resources. Contains detailed recommendations for every future resources specification specified in CalendarModeAdviceRequest.
+      "recommendationsPerSpec": { # Recommendations for every future resource specification passed in CalendarModeAdviceRequest. Keys of the map correspond to keys specified in the request.
+        "a_key": { # Recommendation for single resources specification, to be created in the future.
+          "endTime": "A String",
+          "location": "A String", # The advised location for resource usage. When a zone, in format 'zones/'. If not set, it means that no location is recommended - see other_locations for details.
+          "otherLocations": { # List of locations in the request scope that were not recommended. Keys of the map are zones, in format 'zones/'. The values are status information indicating the recommendation status.
+            "a_key": { # Information about recommendation status for locations that were allowed but not used by the response.
+              "details": "A String", # Details (human readable) describing the situation. For example, if status is CONDITION_NOT_MET, then details contain information about the parameters of the time window that did not meet the required conditions.
+              "status": "A String", # Status of recommendation in this location.
+            },
+          },
+          "recommendationId": "A String", # Unique id of the recommendation, a UUID string generated by the API.
+          "recommendationType": "A String", # Type of recommendation. Currently only FUTURE_RESERVATION is supported.
+          "startTime": "A String",
+        },
+      },
+    },
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_beta.html b/docs/dyn/compute_beta.html index 901cc929e25..da7ed7a1f91 100644 --- a/docs/dyn/compute_beta.html +++ b/docs/dyn/compute_beta.html @@ -84,6 +84,11 @@

Instance Methods

Returns the addresses Resource.

+

+ advice() +

+

Returns the advice Resource.

+

autoscalers()

diff --git a/docs/dyn/compute_beta.instanceGroupManagers.html b/docs/dyn/compute_beta.instanceGroupManagers.html index d49e8ba45c1..56009a9367d 100644 --- a/docs/dyn/compute_beta.instanceGroupManagers.html +++ b/docs/dyn/compute_beta.instanceGroupManagers.html @@ -401,6 +401,7 @@

Method Details

"instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy 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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. @@ -1332,6 +1333,7 @@

Method Details

"instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy 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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. @@ -1511,6 +1513,7 @@

Method Details

"instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy 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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. @@ -1819,6 +1822,7 @@

Method Details

"instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy 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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. @@ -2343,6 +2347,7 @@

Method Details

"instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy 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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. @@ -4174,6 +4179,7 @@

Method Details

"instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy 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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. diff --git a/docs/dyn/compute_beta.interconnects.html b/docs/dyn/compute_beta.interconnects.html index a43a3ff7b73..39b86053235 100644 --- a/docs/dyn/compute_beta.interconnects.html +++ b/docs/dyn/compute_beta.interconnects.html @@ -338,6 +338,9 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. + "wireGroups": [ # [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. + "A String", + ], }
@@ -526,6 +529,9 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. + "wireGroups": [ # [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. + "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). @@ -753,6 +759,9 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. + "wireGroups": [ # [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. + "A String", + ], }, ], "kind": "compute#interconnectList", # [Output Only] Type of resource. Always compute#interconnectList for lists of interconnects. @@ -881,6 +890,9 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. + "wireGroups": [ # [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. + "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). diff --git a/docs/dyn/compute_beta.networkProfiles.html b/docs/dyn/compute_beta.networkProfiles.html index 5d00eafafd4..a8be3b7d643 100644 --- a/docs/dyn/compute_beta.networkProfiles.html +++ b/docs/dyn/compute_beta.networkProfiles.html @@ -151,7 +151,6 @@

Method Details

"name": "A String", # [Output Only] Name of the resource. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. - "zone": "A String", # [Output Only] Zone to which the network is restricted. }
@@ -222,7 +221,6 @@

Method Details

"name": "A String", # [Output Only] Name of the resource. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. - "zone": "A String", # [Output Only] Zone to which the network is restricted. }, ], "kind": "compute#networkProfileList", # [Output Only] Type of resource. Always compute#networkProfileList for network profiles. diff --git a/docs/dyn/compute_beta.nodeTypes.html b/docs/dyn/compute_beta.nodeTypes.html index 3830956a2a8..18e04cba5a6 100644 --- a/docs/dyn/compute_beta.nodeTypes.html +++ b/docs/dyn/compute_beta.nodeTypes.html @@ -140,6 +140,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#nodeType", # [Output Only] The type of the resource. Always compute#nodeType for node types. "localSsdGb": 42, # [Output Only] Local SSD available to the node type, defined in GB. + "maxVms": 42, # [Output Only] Maximum number of VMs that can be created for this node type. "memoryMb": 42, # [Output Only] The amount of physical memory available to the node type, defined in MB. "name": "A String", # [Output Only] Name of the resource. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. @@ -233,6 +234,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#nodeType", # [Output Only] The type of the resource. Always compute#nodeType for node types. "localSsdGb": 42, # [Output Only] Local SSD available to the node type, defined in GB. + "maxVms": 42, # [Output Only] Maximum number of VMs that can be created for this node type. "memoryMb": 42, # [Output Only] The amount of physical memory available to the node type, defined in MB. "name": "A String", # [Output Only] Name of the resource. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. @@ -284,6 +286,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#nodeType", # [Output Only] The type of the resource. Always compute#nodeType for node types. "localSsdGb": 42, # [Output Only] Local SSD available to the node type, defined in GB. + "maxVms": 42, # [Output Only] Maximum number of VMs that can be created for this node type. "memoryMb": 42, # [Output Only] The amount of physical memory available to the node type, defined in MB. "name": "A String", # [Output Only] Name of the resource. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. diff --git a/docs/dyn/compute_beta.regionCommitments.html b/docs/dyn/compute_beta.regionCommitments.html index 36445b9a0b5..3db601e65be 100644 --- a/docs/dyn/compute_beta.regionCommitments.html +++ b/docs/dyn/compute_beta.regionCommitments.html @@ -100,10 +100,10 @@

Instance Methods

Returns permissions that a caller has on the specified resource.

update(project, region, commitment, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)

-

Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.

+

Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be updated: auto_renew and plan.

updateReservations(project, region, commitment, body=None, requestId=None, x__xgafv=None)

-

Transfers GPUs or local SSDs between reservations within commitments.

+

Transfers GPUs or Local SSD disks between reservations that are attached to the same commitment.

Method Details

aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None) @@ -130,31 +130,31 @@

Method Details

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": { # A list of CommitmentsScopedList resources. "a_key": { # [Output Only] Name of the scope containing this set of commitments. - "commitments": [ # [Output Only] A list of commitments contained in this scope. - { # Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. - "autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. - "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. + "commitments": [ # [Output Only] The list of commitments contained in this scope. + { # Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts + "autoRenew": True or False, # Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027. + "category": "A String", # The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. - "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "customEndTimestamp": "A String", # [Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration. + "description": "A String", # An optional description of the commitment. You can provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. - "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation + "existingReservations": [ "A String", ], "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments. "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment. - "amount": "A String", # The number of licenses purchased. - "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies. - "license": "A String", # Any applicable license URI. + "amount": "A String", # The number of licenses you plan to purchase. + "coresPerLicense": "A String", # The number of cores per license. + "license": "A String", # The applicable license URI. }, - "mergeSourceCommitments": [ # List of source commitments to be merged into a new commitment. + "mergeSourceCommitments": [ # The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments. "A String", ], - "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. - "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). - "region": "A String", # [Output Only] URL of the region where this commitment may be used. - "reservations": [ # List of create-on-create reservations for this commitment. + "name": "A String", # Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. + "plan": "A String", # The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). + "region": "A String", # [Output Only] URL of the region where the commitment and committed resources are located. + "reservations": [ # The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead. { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. "aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility. "inUseResources": [ # [Output only] List of resources currently in use. @@ -262,19 +262,19 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Commitment resource. "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, - "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. - { # Commitment for a particular resource (a Commitment is composed of one or more of these). - "acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. - "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. - "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. + "resources": [ # The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type. + { # Commitment for a particular hardware resource (a commitment is composed of one or more of these). + "acceleratorType": "A String", # Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR. + "amount": "A String", # The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. + "type": "A String", # The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type. }, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "splitSourceCommitment": "A String", # Source commitment to be split into a new commitment. + "splitSourceCommitment": "A String", # The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments. "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format. - "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. - "type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. + "type": "A String", # The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. }, ], "warning": { # [Output Only] Informational warning which replaces the list of commitments when the list is empty. @@ -343,30 +343,30 @@

Method Details

Returns: An object of the form: - { # Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. - "autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. - "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. + { # Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts + "autoRenew": True or False, # Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027. + "category": "A String", # The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. - "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "customEndTimestamp": "A String", # [Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration. + "description": "A String", # An optional description of the commitment. You can provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. - "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation + "existingReservations": [ "A String", ], "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments. "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment. - "amount": "A String", # The number of licenses purchased. - "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies. - "license": "A String", # Any applicable license URI. + "amount": "A String", # The number of licenses you plan to purchase. + "coresPerLicense": "A String", # The number of cores per license. + "license": "A String", # The applicable license URI. }, - "mergeSourceCommitments": [ # List of source commitments to be merged into a new commitment. + "mergeSourceCommitments": [ # The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments. "A String", ], - "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. - "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). - "region": "A String", # [Output Only] URL of the region where this commitment may be used. - "reservations": [ # List of create-on-create reservations for this commitment. + "name": "A String", # Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. + "plan": "A String", # The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). + "region": "A String", # [Output Only] URL of the region where the commitment and committed resources are located. + "reservations": [ # The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead. { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. "aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility. "inUseResources": [ # [Output only] List of resources currently in use. @@ -474,19 +474,19 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Commitment resource. "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, - "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. - { # Commitment for a particular resource (a Commitment is composed of one or more of these). - "acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. - "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. - "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. + "resources": [ # The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type. + { # Commitment for a particular hardware resource (a commitment is composed of one or more of these). + "acceleratorType": "A String", # Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR. + "amount": "A String", # The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. + "type": "A String", # The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type. }, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "splitSourceCommitment": "A String", # Source commitment to be split into a new commitment. + "splitSourceCommitment": "A String", # The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments. "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format. - "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. - "type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. + "type": "A String", # The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. }
@@ -500,30 +500,30 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. - "autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. - "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. +{ # Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts + "autoRenew": True or False, # Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027. + "category": "A String", # The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. - "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "customEndTimestamp": "A String", # [Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration. + "description": "A String", # An optional description of the commitment. You can provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. - "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation + "existingReservations": [ "A String", ], "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments. "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment. - "amount": "A String", # The number of licenses purchased. - "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies. - "license": "A String", # Any applicable license URI. + "amount": "A String", # The number of licenses you plan to purchase. + "coresPerLicense": "A String", # The number of cores per license. + "license": "A String", # The applicable license URI. }, - "mergeSourceCommitments": [ # List of source commitments to be merged into a new commitment. + "mergeSourceCommitments": [ # The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments. "A String", ], - "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. - "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). - "region": "A String", # [Output Only] URL of the region where this commitment may be used. - "reservations": [ # List of create-on-create reservations for this commitment. + "name": "A String", # Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. + "plan": "A String", # The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). + "region": "A String", # [Output Only] URL of the region where the commitment and committed resources are located. + "reservations": [ # The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead. { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. "aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility. "inUseResources": [ # [Output only] List of resources currently in use. @@ -631,19 +631,19 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Commitment resource. "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, - "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. - { # Commitment for a particular resource (a Commitment is composed of one or more of these). - "acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. - "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. - "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. + "resources": [ # The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type. + { # Commitment for a particular hardware resource (a commitment is composed of one or more of these). + "acceleratorType": "A String", # Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR. + "amount": "A String", # The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. + "type": "A String", # The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type. }, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "splitSourceCommitment": "A String", # Source commitment to be split into a new commitment. + "splitSourceCommitment": "A String", # The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments. "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format. - "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. - "type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. + "type": "A String", # The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. } 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). @@ -786,30 +786,30 @@

Method Details

{ # Contains a list of Commitment resources. "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of Commitment resources. - { # Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. - "autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. - "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. + { # Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts + "autoRenew": True or False, # Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027. + "category": "A String", # The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. - "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "customEndTimestamp": "A String", # [Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration. + "description": "A String", # An optional description of the commitment. You can provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. - "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation + "existingReservations": [ "A String", ], "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments. "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment. - "amount": "A String", # The number of licenses purchased. - "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies. - "license": "A String", # Any applicable license URI. + "amount": "A String", # The number of licenses you plan to purchase. + "coresPerLicense": "A String", # The number of cores per license. + "license": "A String", # The applicable license URI. }, - "mergeSourceCommitments": [ # List of source commitments to be merged into a new commitment. + "mergeSourceCommitments": [ # The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments. "A String", ], - "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. - "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). - "region": "A String", # [Output Only] URL of the region where this commitment may be used. - "reservations": [ # List of create-on-create reservations for this commitment. + "name": "A String", # Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. + "plan": "A String", # The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). + "region": "A String", # [Output Only] URL of the region where the commitment and committed resources are located. + "reservations": [ # The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead. { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. "aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility. "inUseResources": [ # [Output only] List of resources currently in use. @@ -917,19 +917,19 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Commitment resource. "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, - "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. - { # Commitment for a particular resource (a Commitment is composed of one or more of these). - "acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. - "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. - "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. + "resources": [ # The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type. + { # Commitment for a particular hardware resource (a commitment is composed of one or more of these). + "acceleratorType": "A String", # Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR. + "amount": "A String", # The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. + "type": "A String", # The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type. }, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "splitSourceCommitment": "A String", # Source commitment to be split into a new commitment. + "splitSourceCommitment": "A String", # The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments. "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format. - "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. - "type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. + "type": "A String", # The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. }, ], "kind": "compute#commitmentList", # [Output Only] Type of resource. Always compute#commitmentList for lists of commitments. @@ -996,39 +996,39 @@

Method Details

update(project, region, commitment, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None) -
Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.
+  
Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be updated: auto_renew and plan.
 
 Args:
   project: string, Project ID for this request. (required)
   region: string, Name of the region for this request. (required)
-  commitment: string, Name of the commitment for which auto renew is being updated. (required)
+  commitment: string, Name of the commitment that you want to update. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts.
-  "autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.
-  "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.
+{ # Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts
+  "autoRenew": True or False, # Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027.
+  "category": "A String", # The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to.
   "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-  "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.
-  "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+  "customEndTimestamp": "A String", # [Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration.
+  "description": "A String", # An optional description of the commitment. You can provide this property when you create the resource.
   "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.
-  "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation
+  "existingReservations": [
     "A String",
   ],
   "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
   "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments.
   "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment.
-    "amount": "A String", # The number of licenses purchased.
-    "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies.
-    "license": "A String", # Any applicable license URI.
+    "amount": "A String", # The number of licenses you plan to purchase.
+    "coresPerLicense": "A String", # The number of cores per license.
+    "license": "A String", # The applicable license URI.
   },
-  "mergeSourceCommitments": [ # List of source commitments to be merged into a new commitment.
+  "mergeSourceCommitments": [ # The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.
     "A String",
   ],
-  "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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.
-  "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
-  "region": "A String", # [Output Only] URL of the region where this commitment may be used.
-  "reservations": [ # List of create-on-create reservations for this commitment.
+  "name": "A String", # Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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.
+  "plan": "A String", # The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
+  "region": "A String", # [Output Only] URL of the region where the commitment and committed resources are located.
+  "reservations": [ # The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
     { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.
       "aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility.
         "inUseResources": [ # [Output only] List of resources currently in use.
@@ -1136,19 +1136,19 @@ 

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Commitment resource. "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, - "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. - { # Commitment for a particular resource (a Commitment is composed of one or more of these). - "acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. - "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. - "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. + "resources": [ # The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type. + { # Commitment for a particular hardware resource (a commitment is composed of one or more of these). + "acceleratorType": "A String", # Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR. + "amount": "A String", # The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. + "type": "A String", # The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type. }, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "splitSourceCommitment": "A String", # Source commitment to be split into a new commitment. + "splitSourceCommitment": "A String", # The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments. "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format. - "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. - "type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. + "type": "A String", # The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. } paths: string, A parameter (repeated) @@ -1272,17 +1272,17 @@

Method Details

updateReservations(project, region, commitment, body=None, requestId=None, x__xgafv=None) -
Transfers GPUs or local SSDs between reservations within commitments.
+  
Transfers GPUs or Local SSD disks between reservations that are attached to the same commitment.
 
 Args:
   project: string, Project ID for this request. (required)
   region: string, Name of the region for this request. (required)
-  commitment: string, Name of the commitment for which the reservation is being updated. (required)
+  commitment: string, Name of the commitment for which the reservations are being updated. (required)
   body: object, The request body.
     The object takes the form of:
 
 {
-  "reservations": [ # A list of two reservations to transfer GPUs and local SSD between.
+  "reservations": [ # A list of two reservations to transfer GPUs and Local SSD disks between.
     { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.
       "aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility.
         "inUseResources": [ # [Output only] List of resources currently in use.
diff --git a/docs/dyn/compute_beta.regionInstanceGroupManagers.html b/docs/dyn/compute_beta.regionInstanceGroupManagers.html
index 3ac9e15df9a..261d19cca40 100644
--- a/docs/dyn/compute_beta.regionInstanceGroupManagers.html
+++ b/docs/dyn/compute_beta.regionInstanceGroupManagers.html
@@ -1087,6 +1087,7 @@ 

Method Details

"instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy 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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. @@ -1266,6 +1267,7 @@

Method Details

"instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy 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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. @@ -1574,6 +1576,7 @@

Method Details

"instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy 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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. @@ -2098,6 +2101,7 @@

Method Details

"instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy 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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. @@ -3929,6 +3933,7 @@

Method Details

"instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy 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. + "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 in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. diff --git a/docs/dyn/compute_beta.reservationBlocks.html b/docs/dyn/compute_beta.reservationBlocks.html index 13345d7e003..3373d9018da 100644 --- a/docs/dyn/compute_beta.reservationBlocks.html +++ b/docs/dyn/compute_beta.reservationBlocks.html @@ -86,6 +86,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

+ performMaintenance(project, zone, reservation, reservationBlock, body=None, requestId=None, x__xgafv=None)

+

Allows customers to perform maintenance on a reservation block

Method Details

close() @@ -226,4 +229,137 @@

Method Details

+
+ performMaintenance(project, zone, reservation, reservationBlock, body=None, requestId=None, x__xgafv=None) +
Allows customers to perform maintenance on a reservation block
+
+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)
+  reservation: string, The name of the reservation. Name should conform to RFC1035 or be a resource ID. (required)
+  reservationBlock: string, The name of the reservation block. Name should conform to RFC1035 or be a resource ID. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "maintenanceScope": "A String", # Specifies if all, running or unused hosts are in scope for this request.
+}
+
+  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/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling 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 in RFC3339 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 in RFC3339 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] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [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.
+  "setCommonInstanceMetadataOperationMetadata": { # [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 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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 in RFC3339 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: `user@example.com` 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.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/compute_beta.reservations.html b/docs/dyn/compute_beta.reservations.html index 80e82a12453..fd31d774378 100644 --- a/docs/dyn/compute_beta.reservations.html +++ b/docs/dyn/compute_beta.reservations.html @@ -101,6 +101,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

+ performMaintenance(project, zone, reservation, body=None, requestId=None, x__xgafv=None)

+

Perform maintenance on an extended reservation

resize(project, zone, reservation, body=None, requestId=None, x__xgafv=None)

Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations.

@@ -978,6 +981,138 @@

Method Details

+
+ performMaintenance(project, zone, reservation, body=None, requestId=None, x__xgafv=None) +
Perform maintenance on an extended reservation
+
+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)
+  reservation: string, The name of the reservation. Name should conform to RFC1035 or be a resource ID. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "maintenanceScope": "A String", # Specifies if all, running or unused hosts are in scope for this request.
+}
+
+  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/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling 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 in RFC3339 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 in RFC3339 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] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [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.
+  "setCommonInstanceMetadataOperationMetadata": { # [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 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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 in RFC3339 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: `user@example.com` 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.
+}
+
+
resize(project, zone, reservation, body=None, requestId=None, x__xgafv=None)
Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations.
diff --git a/docs/dyn/compute_beta.routers.html b/docs/dyn/compute_beta.routers.html
index 437c1444d4a..31ef223d2a2 100644
--- a/docs/dyn/compute_beta.routers.html
+++ b/docs/dyn/compute_beta.routers.html
@@ -243,7 +243,7 @@ 

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. @@ -723,7 +723,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. @@ -1353,7 +1353,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. @@ -1656,7 +1656,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. @@ -2035,7 +2035,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. @@ -2480,7 +2480,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. @@ -2652,7 +2652,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. @@ -2860,7 +2860,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. diff --git a/docs/dyn/compute_v1.firewallPolicies.html b/docs/dyn/compute_v1.firewallPolicies.html index 0fce568e607..3ae745525f0 100644 --- a/docs/dyn/compute_v1.firewallPolicies.html +++ b/docs/dyn/compute_v1.firewallPolicies.html @@ -751,6 +751,79 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -1018,6 +1091,79 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -1256,6 +1402,79 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -1544,6 +1763,79 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html index cb22e26f213..0189a4f886e 100644 --- a/docs/dyn/compute_v1.instances.html +++ b/docs/dyn/compute_v1.instances.html @@ -2260,6 +2260,79 @@

Method Details

{ "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy. "name": "A String", # [Output Only] The name of the firewall policy. + "packetMirroringRules": [ # [Output Only] The packet mirroring rules that apply to the instance. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "priority": 42, # [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. "rules": [ # [Output Only] The rules that apply to the instance. Only rules that target the specific VM instance are returned if target service accounts or target secure tags are specified in the rules. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). diff --git a/docs/dyn/compute_v1.networkFirewallPolicies.html b/docs/dyn/compute_v1.networkFirewallPolicies.html index 7f5196b917c..d84c3a5a448 100644 --- a/docs/dyn/compute_v1.networkFirewallPolicies.html +++ b/docs/dyn/compute_v1.networkFirewallPolicies.html @@ -77,6 +77,9 @@

Instance Methods

addAssociation(project, firewallPolicy, body=None, replaceExistingAssociation=None, requestId=None, x__xgafv=None)

Inserts an association for the specified firewall policy.

+

+ addPacketMirroringRule(project, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None)

+

Inserts a packet mirroring rule into a firewall policy.

addRule(project, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None)

Inserts a rule into a firewall policy.

@@ -104,6 +107,9 @@

Instance Methods

getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

+

+ getPacketMirroringRule(project, firewallPolicy, priority=None, x__xgafv=None)

+

Gets a packet mirroring rule of the specified priority.

getRule(project, firewallPolicy, priority=None, x__xgafv=None)

Gets a rule of the specified priority.

@@ -119,12 +125,18 @@

Instance Methods

patch(project, firewallPolicy, body=None, requestId=None, x__xgafv=None)

Patches the specified policy with the data included in the request.

+

+ patchPacketMirroringRule(project, firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)

+

Patches a packet mirroring rule of the specified priority.

patchRule(project, firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)

Patches a rule of the specified priority.

removeAssociation(project, firewallPolicy, name=None, requestId=None, x__xgafv=None)

Removes an association for the specified firewall policy.

+

+ removePacketMirroringRule(project, firewallPolicy, priority=None, requestId=None, x__xgafv=None)

+

Deletes a packet mirroring rule of the specified priority.

removeRule(project, firewallPolicy, priority=None, requestId=None, x__xgafv=None)

Deletes a rule of the specified priority.

@@ -272,8 +284,8 @@

Method Details

- addRule(project, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None) -
Inserts a rule into a firewall policy.
+    addPacketMirroringRule(project, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None)
+  
Inserts a packet mirroring rule into a firewall policy.
 
 Args:
   project: string, Project ID for this request. (required)
@@ -473,183 +485,90 @@ 

Method Details

- aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None) -
Retrieves an aggregated list of network firewall policies, listing network firewall policies from all applicable scopes (global and regional) and grouping the results per scope. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
+    addRule(project, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None)
+  
Inserts a rule into a firewall policy.
 
 Args:
   project: string, Project ID for this request. (required)
-  filter: string, A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
-  includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
-  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
-  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
-  pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
-  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
-  serviceProjectNumber: string, The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
+  firewallPolicy: string, Name of the firewall policy to update. (required)
+  body: object, The request body.
+    The object takes the form of:
 
-    {
-  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
-  "items": { # A list of FirewallPoliciesScopedList resources.
-    "a_key": { # Name of the scope containing this set of addresses.
-      "firewallPolicies": [ # A list of firewall policies contained in this scope.
-        { # Represents a Firewall Policy resource.
-          "associations": [ # A list of associations that belong to this firewall policy.
-            {
-              "attachmentTarget": "A String", # The target that the firewall policy is attached to.
-              "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association.
-              "firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association.
-              "name": "A String", # The name for an association.
-              "shortName": "A String", # [Output Only] The short name of the firewall policy of the association.
-            },
-          ],
-          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
-          "displayName": "A String", # Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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.
-          "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy.
-          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
-          "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies
-          "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.
-          "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.
-          "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
-          "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.
-          "rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.
-            { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
-              "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next".
-              "description": "A String", # An optional description for this resource.
-              "direction": "A String", # The direction in which this rule applies.
-              "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
-              "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
-              "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules.
-              "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
-                "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
-                  "A String",
-                ],
-                "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
-                  "A String",
-                ],
-                "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
-                  "A String",
-                ],
-                "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
-                  "A String",
-                ],
-                "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
-                  "A String",
-                ],
-                "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
-                  {
-                    "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
-                    "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
-                      "A String",
-                    ],
-                  },
-                ],
-                "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
-                  "A String",
-                ],
-                "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
-                  "A String",
-                ],
-                "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
-                  "A String",
-                ],
-                "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
-                  "A String",
-                ],
-                "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
-                  {
-                    "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
-                    "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
-                  },
-                ],
-                "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
-                  "A String",
-                ],
-              },
-              "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
-              "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
-              "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
-              "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions.
-              "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
-                "A String",
-              ],
-              "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
-                {
-                  "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
-                  "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
-                },
-              ],
-              "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
-                "A String",
-              ],
-              "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
-            },
-          ],
-          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
-          "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
-          "shortName": "A String", # User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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.
-        },
-      ],
-      "warning": { # Informational warning which replaces the list of firewall policies when the list is empty.
-        "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.
-          },
+{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+  "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next".
+  "description": "A String", # An optional description for this resource.
+  "direction": "A String", # The direction in which this rule applies.
+  "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
+  "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
+  "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules.
+  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+    "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
+      "A String",
+    ],
+    "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
+      "A String",
+    ],
+    "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
+      "A String",
+    ],
+    "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
+      "A String",
+    ],
+    "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+      {
+        "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+          "A String",
         ],
-        "message": "A String", # [Output Only] A human-readable description of the warning code.
       },
-    },
-  },
-  "kind": "compute#networkFirewallPolicyAggregatedList", # [Output Only] Type of resource. Always compute#networkFirewallPoliciesAggregatedList for lists of network firewall policies.
-  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
-  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
-  "unreachables": [ # [Output Only] Unreachable resources.
-    "A String",
-  ],
-  "warning": { # [Output Only] Informational warning message.
-    "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" }
+    ],
+    "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
+      "A String",
+    ],
+    "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
+      "A String",
+    ],
+    "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
+      "A String",
+    ],
+    "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
       {
-        "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.
+        "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+        "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
       },
     ],
-    "message": "A String", # [Output Only] A human-readable description of the warning code.
+    "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
+      "A String",
+    ],
   },
-}
-
- -
- aggregatedList_next() -
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.
-        
-
- -
- cloneRules(project, firewallPolicy, requestId=None, sourceFirewallPolicy=None, x__xgafv=None) -
Copies rules to the specified firewall policy.
+  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
+  "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+  "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
+  "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions.
+  "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
+    "A String",
+  ],
+  "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+    {
+      "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+      "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+    },
+  ],
+  "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+    "A String",
+  ],
+  "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
+}
 
-Args:
-  project: string, Project ID for this request. (required)
-  firewallPolicy: string, Name of the firewall policy to update. (required)
+  maxPriority: integer, When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.
+  minPriority: integer, When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.
   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).
-  sourceFirewallPolicy: string, The firewall policy from which to copy rules.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -767,20 +686,387 @@ 

Method Details

- close() -
Close httplib2 connections.
-
- -
- delete(project, firewallPolicy, requestId=None, x__xgafv=None) -
Deletes the specified policy.
+    aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
+  
Retrieves an aggregated list of network firewall policies, listing network firewall policies from all applicable scopes (global and regional) and grouping the results per scope. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
 
 Args:
   project: string, Project ID for this request. (required)
-  firewallPolicy: string, Name of the firewall policy to delete. (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
+  filter: string, A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
+  includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
+  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
+  serviceProjectNumber: string, The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": { # A list of FirewallPoliciesScopedList resources.
+    "a_key": { # Name of the scope containing this set of addresses.
+      "firewallPolicies": [ # A list of firewall policies contained in this scope.
+        { # Represents a Firewall Policy resource.
+          "associations": [ # A list of associations that belong to this firewall policy.
+            {
+              "attachmentTarget": "A String", # The target that the firewall policy is attached to.
+              "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association.
+              "firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association.
+              "name": "A String", # The name for an association.
+              "shortName": "A String", # [Output Only] The short name of the firewall policy of the association.
+            },
+          ],
+          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+          "displayName": "A String", # Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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.
+          "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy.
+          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+          "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies
+          "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.
+          "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy.
+            { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+              "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next".
+              "description": "A String", # An optional description for this resource.
+              "direction": "A String", # The direction in which this rule applies.
+              "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
+              "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
+              "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules.
+              "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+                "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
+                  "A String",
+                ],
+                "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
+                  "A String",
+                ],
+                "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+                  "A String",
+                ],
+                "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
+                  "A String",
+                ],
+                "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
+                  "A String",
+                ],
+                "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+                  {
+                    "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+                    "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+                      "A String",
+                    ],
+                  },
+                ],
+                "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
+                  "A String",
+                ],
+                "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
+                  "A String",
+                ],
+                "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+                  "A String",
+                ],
+                "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
+                  "A String",
+                ],
+                "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
+                  {
+                    "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+                    "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+                  },
+                ],
+                "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
+                  "A String",
+                ],
+              },
+              "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
+              "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+              "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
+              "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions.
+              "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
+                "A String",
+              ],
+              "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+                {
+                  "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+                  "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+                },
+              ],
+              "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+                "A String",
+              ],
+              "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
+            },
+          ],
+          "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.
+          "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+          "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.
+          "rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.
+            { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+              "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next".
+              "description": "A String", # An optional description for this resource.
+              "direction": "A String", # The direction in which this rule applies.
+              "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
+              "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
+              "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules.
+              "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+                "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
+                  "A String",
+                ],
+                "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
+                  "A String",
+                ],
+                "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+                  "A String",
+                ],
+                "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
+                  "A String",
+                ],
+                "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
+                  "A String",
+                ],
+                "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+                  {
+                    "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+                    "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+                      "A String",
+                    ],
+                  },
+                ],
+                "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
+                  "A String",
+                ],
+                "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
+                  "A String",
+                ],
+                "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+                  "A String",
+                ],
+                "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
+                  "A String",
+                ],
+                "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
+                  {
+                    "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+                    "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+                  },
+                ],
+                "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
+                  "A String",
+                ],
+              },
+              "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
+              "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+              "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
+              "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions.
+              "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
+                "A String",
+              ],
+              "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+                {
+                  "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+                  "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+                },
+              ],
+              "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+                "A String",
+              ],
+              "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
+            },
+          ],
+          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+          "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+          "shortName": "A String", # User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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.
+        },
+      ],
+      "warning": { # Informational warning which replaces the list of firewall policies when the list is empty.
+        "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.
+      },
+    },
+  },
+  "kind": "compute#networkFirewallPolicyAggregatedList", # [Output Only] Type of resource. Always compute#networkFirewallPoliciesAggregatedList for lists of network firewall policies.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # [Output Only] Unreachable resources.
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "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.
+  },
+}
+
+ +
+ aggregatedList_next() +
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.
+        
+
+ +
+ cloneRules(project, firewallPolicy, requestId=None, sourceFirewallPolicy=None, x__xgafv=None) +
Copies rules to the specified firewall policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  firewallPolicy: string, Name of the firewall policy to update. (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).
+  sourceFirewallPolicy: string, The firewall policy from which to copy rules.
+  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/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling 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 in RFC3339 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 in RFC3339 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] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [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.
+  "setCommonInstanceMetadataOperationMetadata": { # [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 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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 in RFC3339 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: `user@example.com` 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.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(project, firewallPolicy, requestId=None, x__xgafv=None) +
Deletes the specified policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  firewallPolicy: string, Name of the firewall policy to delete. (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
 
@@ -927,6 +1213,79 @@ 

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -1083,6 +1442,95 @@

Method Details

}
+
+ getPacketMirroringRule(project, firewallPolicy, priority=None, x__xgafv=None) +
Gets a packet mirroring rule of the specified priority.
+
+Args:
+  project: string, Project ID for this request. (required)
+  firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required)
+  priority: integer, The priority of the rule to get from the firewall policy.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+  "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next".
+  "description": "A String", # An optional description for this resource.
+  "direction": "A String", # The direction in which this rule applies.
+  "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
+  "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
+  "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules.
+  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+    "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
+      "A String",
+    ],
+    "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
+      "A String",
+    ],
+    "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
+      "A String",
+    ],
+    "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
+      "A String",
+    ],
+    "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+      {
+        "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+          "A String",
+        ],
+      },
+    ],
+    "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
+      "A String",
+    ],
+    "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
+      "A String",
+    ],
+    "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
+      "A String",
+    ],
+    "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
+      {
+        "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+        "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+      },
+    ],
+    "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
+      "A String",
+    ],
+  },
+  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
+  "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+  "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
+  "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions.
+  "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
+    "A String",
+  ],
+  "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+    {
+      "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+      "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+    },
+  ],
+  "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+    "A String",
+  ],
+  "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
+}
+
+
getRule(project, firewallPolicy, priority=None, x__xgafv=None)
Gets a rule of the specified priority.
@@ -1191,13 +1639,86 @@ 

Method Details

"shortName": "A String", # [Output Only] The short name of the firewall policy of the association. }, ], - "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "description": "A String", # An optional description of this resource. Provide this property when you create the resource. - "displayName": "A String", # Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. - "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy. - "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. - "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies - "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "displayName": "A String", # Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. + "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies + "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -1435,6 +1956,79 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -1572,6 +2166,79 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -1629,30 +2296,230 @@

Method Details

"A String", ], }, - "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. - "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. - "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. - "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. - "A String", - ], - "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], + "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. + "shortName": "A String", # User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. +} + + 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/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling 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 in RFC3339 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 in RFC3339 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] Type of the resource. Always `compute#operation` for Operation resources. + "name": "A String", # [Output Only] Name of the operation. + "operationGroupId": "A String", # [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. + "setCommonInstanceMetadataOperationMetadata": { # [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 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] If state is `ABANDONED` or `FAILED`, this field is populated. + "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 in RFC3339 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: `user@example.com` 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" } { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + "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. }, ], - "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. - "A String", - ], - "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + "message": "A String", # [Output Only] A human-readable description of the warning code. }, ], - "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. - "shortName": "A String", # User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. +}
+
+ +
+ patchPacketMirroringRule(project, firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None) +
Patches a packet mirroring rule of the specified priority.
+
+Args:
+  project: string, Project ID for this request. (required)
+  firewallPolicy: string, Name of the firewall policy to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+  "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next".
+  "description": "A String", # An optional description for this resource.
+  "direction": "A String", # The direction in which this rule applies.
+  "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
+  "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
+  "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules.
+  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+    "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
+      "A String",
+    ],
+    "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
+      "A String",
+    ],
+    "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
+      "A String",
+    ],
+    "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
+      "A String",
+    ],
+    "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+      {
+        "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+          "A String",
+        ],
+      },
+    ],
+    "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
+      "A String",
+    ],
+    "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
+      "A String",
+    ],
+    "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
+      "A String",
+    ],
+    "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
+      {
+        "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+        "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+      },
+    ],
+    "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
+      "A String",
+    ],
+  },
+  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
+  "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+  "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
+  "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions.
+  "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
+    "A String",
+  ],
+  "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+    {
+      "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+      "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+    },
+  ],
+  "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+    "A String",
+  ],
+  "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
 }
 
+  priority: integer, The priority of the rule to patch.
   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
@@ -2095,6 +2962,131 @@ 

Method Details

}
+
+ removePacketMirroringRule(project, firewallPolicy, priority=None, requestId=None, x__xgafv=None) +
Deletes a packet mirroring rule of the specified priority.
+
+Args:
+  project: string, Project ID for this request. (required)
+  firewallPolicy: string, Name of the firewall policy to update. (required)
+  priority: integer, The priority of the rule to remove from the firewall policy.
+  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/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling 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 in RFC3339 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 in RFC3339 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] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [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.
+  "setCommonInstanceMetadataOperationMetadata": { # [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 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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 in RFC3339 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: `user@example.com` 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.
+}
+
+
removeRule(project, firewallPolicy, priority=None, requestId=None, x__xgafv=None)
Deletes a rule of the specified priority.
diff --git a/docs/dyn/compute_v1.networkProfiles.html b/docs/dyn/compute_v1.networkProfiles.html
index 9dddc98b1b9..00f4744dfe5 100644
--- a/docs/dyn/compute_v1.networkProfiles.html
+++ b/docs/dyn/compute_v1.networkProfiles.html
@@ -151,7 +151,6 @@ 

Method Details

"name": "A String", # [Output Only] Name of the resource. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. - "zone": "A String", # [Output Only] Zone to which the network is restricted. }
@@ -222,7 +221,6 @@

Method Details

"name": "A String", # [Output Only] Name of the resource. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. - "zone": "A String", # [Output Only] Zone to which the network is restricted. }, ], "kind": "compute#networkProfileList", # [Output Only] Type of resource. Always compute#networkProfileList for network profiles. diff --git a/docs/dyn/compute_v1.networks.html b/docs/dyn/compute_v1.networks.html index 795d59e4a7b..1cffd08859b 100644 --- a/docs/dyn/compute_v1.networks.html +++ b/docs/dyn/compute_v1.networks.html @@ -475,6 +475,79 @@

Method Details

{ "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy. "name": "A String", # [Output Only] The name of the firewall policy. + "packetMirroringRules": [ # [Output Only] The packet mirroring rules that apply to the network. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "priority": 42, # [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. "rules": [ # [Output Only] The rules that apply to the network. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). diff --git a/docs/dyn/compute_v1.nodeTypes.html b/docs/dyn/compute_v1.nodeTypes.html index cfb591ad440..40155197209 100644 --- a/docs/dyn/compute_v1.nodeTypes.html +++ b/docs/dyn/compute_v1.nodeTypes.html @@ -134,6 +134,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#nodeType", # [Output Only] The type of the resource. Always compute#nodeType for node types. "localSsdGb": 42, # [Output Only] Local SSD available to the node type, defined in GB. + "maxVms": 42, # [Output Only] Maximum number of VMs that can be created for this node type. "memoryMb": 42, # [Output Only] The amount of physical memory available to the node type, defined in MB. "name": "A String", # [Output Only] Name of the resource. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. @@ -221,6 +222,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#nodeType", # [Output Only] The type of the resource. Always compute#nodeType for node types. "localSsdGb": 42, # [Output Only] Local SSD available to the node type, defined in GB. + "maxVms": 42, # [Output Only] Maximum number of VMs that can be created for this node type. "memoryMb": 42, # [Output Only] The amount of physical memory available to the node type, defined in MB. "name": "A String", # [Output Only] Name of the resource. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. @@ -266,6 +268,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#nodeType", # [Output Only] The type of the resource. Always compute#nodeType for node types. "localSsdGb": 42, # [Output Only] Local SSD available to the node type, defined in GB. + "maxVms": 42, # [Output Only] Maximum number of VMs that can be created for this node type. "memoryMb": 42, # [Output Only] The amount of physical memory available to the node type, defined in MB. "name": "A String", # [Output Only] Name of the resource. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. diff --git a/docs/dyn/compute_v1.regionCommitments.html b/docs/dyn/compute_v1.regionCommitments.html index 06ed990141b..ce0ecd9a85d 100644 --- a/docs/dyn/compute_v1.regionCommitments.html +++ b/docs/dyn/compute_v1.regionCommitments.html @@ -97,7 +97,7 @@

Instance Methods

Retrieves the next page of results.

update(project, region, commitment, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)

-

Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.

+

Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be updated: auto_renew and plan.

Method Details

aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None) @@ -124,31 +124,31 @@

Method Details

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": { # A list of CommitmentsScopedList resources. "a_key": { # [Output Only] Name of the scope containing this set of commitments. - "commitments": [ # [Output Only] A list of commitments contained in this scope. - { # Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. - "autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. - "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. + "commitments": [ # [Output Only] The list of commitments contained in this scope. + { # Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts + "autoRenew": True or False, # Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027. + "category": "A String", # The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. - "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "customEndTimestamp": "A String", # [Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration. + "description": "A String", # An optional description of the commitment. You can provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. - "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation + "existingReservations": [ "A String", ], "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments. "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment. - "amount": "A String", # The number of licenses purchased. - "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies. - "license": "A String", # Any applicable license URI. + "amount": "A String", # The number of licenses you plan to purchase. + "coresPerLicense": "A String", # The number of cores per license. + "license": "A String", # The applicable license URI. }, - "mergeSourceCommitments": [ # List of source commitments to be merged into a new commitment. + "mergeSourceCommitments": [ # The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments. "A String", ], - "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. - "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). - "region": "A String", # [Output Only] URL of the region where this commitment may be used. - "reservations": [ # List of create-on-create reservations for this commitment. + "name": "A String", # Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. + "plan": "A String", # The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). + "region": "A String", # [Output Only] URL of the region where the commitment and committed resources are located. + "reservations": [ # The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead. { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. "aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility. "inUseResources": [ # [Output only] List of resources currently in use. @@ -225,19 +225,19 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Commitment resource. "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, - "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. - { # Commitment for a particular resource (a Commitment is composed of one or more of these). - "acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. - "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. - "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. + "resources": [ # The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type. + { # Commitment for a particular hardware resource (a commitment is composed of one or more of these). + "acceleratorType": "A String", # Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR. + "amount": "A String", # The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. + "type": "A String", # The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type. }, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "splitSourceCommitment": "A String", # Source commitment to be split into a new commitment. + "splitSourceCommitment": "A String", # The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments. "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format. - "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. - "type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. + "type": "A String", # The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. }, ], "warning": { # [Output Only] Informational warning which replaces the list of commitments when the list is empty. @@ -306,30 +306,30 @@

Method Details

Returns: An object of the form: - { # Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. - "autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. - "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. + { # Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts + "autoRenew": True or False, # Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027. + "category": "A String", # The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. - "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "customEndTimestamp": "A String", # [Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration. + "description": "A String", # An optional description of the commitment. You can provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. - "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation + "existingReservations": [ "A String", ], "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments. "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment. - "amount": "A String", # The number of licenses purchased. - "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies. - "license": "A String", # Any applicable license URI. + "amount": "A String", # The number of licenses you plan to purchase. + "coresPerLicense": "A String", # The number of cores per license. + "license": "A String", # The applicable license URI. }, - "mergeSourceCommitments": [ # List of source commitments to be merged into a new commitment. + "mergeSourceCommitments": [ # The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments. "A String", ], - "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. - "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). - "region": "A String", # [Output Only] URL of the region where this commitment may be used. - "reservations": [ # List of create-on-create reservations for this commitment. + "name": "A String", # Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. + "plan": "A String", # The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). + "region": "A String", # [Output Only] URL of the region where the commitment and committed resources are located. + "reservations": [ # The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead. { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. "aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility. "inUseResources": [ # [Output only] List of resources currently in use. @@ -406,19 +406,19 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Commitment resource. "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, - "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. - { # Commitment for a particular resource (a Commitment is composed of one or more of these). - "acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. - "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. - "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. + "resources": [ # The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type. + { # Commitment for a particular hardware resource (a commitment is composed of one or more of these). + "acceleratorType": "A String", # Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR. + "amount": "A String", # The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. + "type": "A String", # The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type. }, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "splitSourceCommitment": "A String", # Source commitment to be split into a new commitment. + "splitSourceCommitment": "A String", # The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments. "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format. - "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. - "type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. + "type": "A String", # The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. }
@@ -432,30 +432,30 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. - "autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. - "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. +{ # Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts + "autoRenew": True or False, # Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027. + "category": "A String", # The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. - "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "customEndTimestamp": "A String", # [Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration. + "description": "A String", # An optional description of the commitment. You can provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. - "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation + "existingReservations": [ "A String", ], "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments. "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment. - "amount": "A String", # The number of licenses purchased. - "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies. - "license": "A String", # Any applicable license URI. + "amount": "A String", # The number of licenses you plan to purchase. + "coresPerLicense": "A String", # The number of cores per license. + "license": "A String", # The applicable license URI. }, - "mergeSourceCommitments": [ # List of source commitments to be merged into a new commitment. + "mergeSourceCommitments": [ # The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments. "A String", ], - "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. - "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). - "region": "A String", # [Output Only] URL of the region where this commitment may be used. - "reservations": [ # List of create-on-create reservations for this commitment. + "name": "A String", # Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. + "plan": "A String", # The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). + "region": "A String", # [Output Only] URL of the region where the commitment and committed resources are located. + "reservations": [ # The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead. { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. "aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility. "inUseResources": [ # [Output only] List of resources currently in use. @@ -532,19 +532,19 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Commitment resource. "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, - "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. - { # Commitment for a particular resource (a Commitment is composed of one or more of these). - "acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. - "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. - "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. + "resources": [ # The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type. + { # Commitment for a particular hardware resource (a commitment is composed of one or more of these). + "acceleratorType": "A String", # Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR. + "amount": "A String", # The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. + "type": "A String", # The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type. }, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "splitSourceCommitment": "A String", # Source commitment to be split into a new commitment. + "splitSourceCommitment": "A String", # The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments. "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format. - "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. - "type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. + "type": "A String", # The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. } 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). @@ -687,30 +687,30 @@

Method Details

{ # Contains a list of Commitment resources. "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of Commitment resources. - { # Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. - "autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. - "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. + { # Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts + "autoRenew": True or False, # Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027. + "category": "A String", # The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. - "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "customEndTimestamp": "A String", # [Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration. + "description": "A String", # An optional description of the commitment. You can provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. - "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation + "existingReservations": [ "A String", ], "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments. "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment. - "amount": "A String", # The number of licenses purchased. - "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies. - "license": "A String", # Any applicable license URI. + "amount": "A String", # The number of licenses you plan to purchase. + "coresPerLicense": "A String", # The number of cores per license. + "license": "A String", # The applicable license URI. }, - "mergeSourceCommitments": [ # List of source commitments to be merged into a new commitment. + "mergeSourceCommitments": [ # The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments. "A String", ], - "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. - "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). - "region": "A String", # [Output Only] URL of the region where this commitment may be used. - "reservations": [ # List of create-on-create reservations for this commitment. + "name": "A String", # Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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. + "plan": "A String", # The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). + "region": "A String", # [Output Only] URL of the region where the commitment and committed resources are located. + "reservations": [ # The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead. { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. "aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility. "inUseResources": [ # [Output only] List of resources currently in use. @@ -787,19 +787,19 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Commitment resource. "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, - "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. - { # Commitment for a particular resource (a Commitment is composed of one or more of these). - "acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. - "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. - "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. + "resources": [ # The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type. + { # Commitment for a particular hardware resource (a commitment is composed of one or more of these). + "acceleratorType": "A String", # Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR. + "amount": "A String", # The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. + "type": "A String", # The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type. }, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "splitSourceCommitment": "A String", # Source commitment to be split into a new commitment. + "splitSourceCommitment": "A String", # The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments. "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format. - "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. - "type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. + "type": "A String", # The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. }, ], "kind": "compute#commitmentList", # [Output Only] Type of resource. Always compute#commitmentList for lists of commitments. @@ -834,39 +834,39 @@

Method Details

update(project, region, commitment, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None) -
Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.
+  
Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be updated: auto_renew and plan.
 
 Args:
   project: string, Project ID for this request. (required)
   region: string, Name of the region for this request. (required)
-  commitment: string, Name of the commitment for which auto renew is being updated. (required)
+  commitment: string, Name of the commitment that you want to update. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts.
-  "autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.
-  "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.
+{ # Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts
+  "autoRenew": True or False, # Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027.
+  "category": "A String", # The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to.
   "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-  "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.
-  "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+  "customEndTimestamp": "A String", # [Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration.
+  "description": "A String", # An optional description of the commitment. You can provide this property when you create the resource.
   "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.
-  "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation
+  "existingReservations": [
     "A String",
   ],
   "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
   "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments.
   "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment.
-    "amount": "A String", # The number of licenses purchased.
-    "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies.
-    "license": "A String", # Any applicable license URI.
+    "amount": "A String", # The number of licenses you plan to purchase.
+    "coresPerLicense": "A String", # The number of cores per license.
+    "license": "A String", # The applicable license URI.
   },
-  "mergeSourceCommitments": [ # List of source commitments to be merged into a new commitment.
+  "mergeSourceCommitments": [ # The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.
     "A String",
   ],
-  "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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.
-  "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
-  "region": "A String", # [Output Only] URL of the region where this commitment may be used.
-  "reservations": [ # List of create-on-create reservations for this commitment.
+  "name": "A String", # Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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.
+  "plan": "A String", # The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
+  "region": "A String", # [Output Only] URL of the region where the commitment and committed resources are located.
+  "reservations": [ # The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
     { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.
       "aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility.
         "inUseResources": [ # [Output only] List of resources currently in use.
@@ -943,19 +943,19 @@ 

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Commitment resource. "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, - "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. - { # Commitment for a particular resource (a Commitment is composed of one or more of these). - "acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. - "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. - "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. + "resources": [ # The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type. + { # Commitment for a particular hardware resource (a commitment is composed of one or more of these). + "acceleratorType": "A String", # Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR. + "amount": "A String", # The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. + "type": "A String", # The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type. }, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "splitSourceCommitment": "A String", # Source commitment to be split into a new commitment. + "splitSourceCommitment": "A String", # The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments. "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format. - "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. - "type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. + "type": "A String", # The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. } paths: string, A parameter (repeated) diff --git a/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html b/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html index 706a15ca49b..ed22cf35f79 100644 --- a/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html +++ b/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html @@ -760,6 +760,79 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -889,6 +962,79 @@

Method Details

{ "displayName": "A String", # [Output Only] The display name of the firewall policy. "name": "A String", # [Output Only] The name of the firewall policy. + "packetMirroringRules": [ # [Output only] The packet mirroring rules that apply to the network. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "rules": [ # [Output only] The rules that apply to the network. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". @@ -1187,6 +1333,79 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -1425,6 +1644,79 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -1563,6 +1855,79 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. diff --git a/docs/dyn/compute_v1.routers.html b/docs/dyn/compute_v1.routers.html index bb8f0715826..d196a614abe 100644 --- a/docs/dyn/compute_v1.routers.html +++ b/docs/dyn/compute_v1.routers.html @@ -216,7 +216,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. @@ -564,7 +564,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. @@ -1139,7 +1139,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. @@ -1436,7 +1436,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. @@ -1634,7 +1634,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. @@ -1919,7 +1919,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. @@ -2085,7 +2085,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. @@ -2255,7 +2255,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "interfaces": [ # Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface. { - "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + "ipRange": "A String", # IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. "ipVersion": "A String", # IP version of this interface. "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork. diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index ea1fd975452..282de2221c0 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -16258,6 +16258,43 @@ }, "interconnectGroups": { "methods": { +"createMembers": { +"description": "Create Interconnects with redundancy by creating them in a specified interconnect group.", +"flatPath": "projects/{project}/global/interconnectGroups/{interconnectGroup}/createMembers", +"httpMethod": "POST", +"id": "compute.interconnectGroups.createMembers", +"parameterOrder": [ +"project", +"interconnectGroup" +], +"parameters": { +"interconnectGroup": { +"description": "Name of the group resource to create members 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": "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" +} +}, +"path": "projects/{project}/global/interconnectGroups/{interconnectGroup}/createMembers", +"request": { +"$ref": "InterconnectGroupsCreateMembersRequest" +}, +"response": { +"$ref": "InterconnectGroupsCreateMembersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "delete": { "description": "Deletes the specified InterconnectGroup in the given scope", "flatPath": "projects/{project}/global/interconnectGroups/{interconnectGroup}", @@ -26095,7 +26132,7 @@ ] }, "update": { -"description": "Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.", +"description": "Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be updated: auto_renew and plan.", "flatPath": "projects/{project}/regions/{region}/commitments/{commitment}", "httpMethod": "PATCH", "id": "compute.regionCommitments.update", @@ -26106,7 +26143,7 @@ ], "parameters": { "commitment": { -"description": "Name of the commitment for which auto renew is being updated.", +"description": "Name of the commitment that you want to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -26156,7 +26193,7 @@ ] }, "updateReservations": { -"description": "Transfers GPUs or local SSDs between reservations within commitments.", +"description": "Transfers GPUs or Local SSD disks between reservations that are attached to the same commitment.", "flatPath": "projects/{project}/regions/{region}/commitments/{commitment}/updateReservations", "httpMethod": "POST", "id": "compute.regionCommitments.updateReservations", @@ -26167,7 +26204,7 @@ ], "parameters": { "commitment": { -"description": "Name of the commitment for which the reservation is being updated.", +"description": "Name of the commitment for which the reservations are being updated.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -47599,7 +47636,7 @@ } } }, -"revision": "20250107", +"revision": "20250126", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -51136,6 +51173,10 @@ false "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, +"dynamicForwarding": { +"$ref": "BackendServiceDynamicForwarding", +"description": "Dynamic forwarding configuration. This field is used to configure the backend service with dynamic forwarding feature which together with Service Extension allows customized and complex routing logic." +}, "edgeSecurityPolicy": { "description": "[Output Only] The resource URL for the edge security policy associated with this backend service.", "type": "string" @@ -51762,6 +51803,28 @@ false }, "type": "object" }, +"BackendServiceDynamicForwarding": { +"description": "Defines a dynamic forwarding configuration for the backend service.", +"id": "BackendServiceDynamicForwarding", +"properties": { +"ipPortSelection": { +"$ref": "BackendServiceDynamicForwardingIpPortSelection", +"description": "IP:PORT based dynamic forwarding configuration." +} +}, +"type": "object" +}, +"BackendServiceDynamicForwardingIpPortSelection": { +"description": "Defines a IP:PORT based dynamic forwarding configuration for the backend service. Some ranges are restricted: Restricted ranges.", +"id": "BackendServiceDynamicForwardingIpPortSelection", +"properties": { +"enabled": { +"description": "A boolean flag enabling IP:PORT based dynamic forwarding.", +"type": "boolean" +} +}, +"type": "object" +}, "BackendServiceFailoverPolicy": { "description": "For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes).", "id": "BackendServiceFailoverPolicy", @@ -53311,15 +53374,15 @@ false "type": "object" }, "Commitment": { -"description": "Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts.", +"description": "Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts", "id": "Commitment", "properties": { "autoRenew": { -"description": "Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.", +"description": "Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027.", "type": "boolean" }, "category": { -"description": "The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.", +"description": "The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to.", "enum": [ "CATEGORY_UNSPECIFIED", "LICENSE", @@ -53337,11 +53400,11 @@ false "type": "string" }, "customEndTimestamp": { -"description": "[Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.", +"description": "[Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration.", "type": "string" }, "description": { -"description": "An optional description of this resource. Provide this property when you create the resource.", +"description": "An optional description of the commitment. You can provide this property when you create the resource.", "type": "string" }, "endTimestamp": { @@ -53349,7 +53412,6 @@ false "type": "string" }, "existingReservations": { -"description": "Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation ", "items": { "type": "string" }, @@ -53370,19 +53432,19 @@ false "description": "The license specification required as part of a license commitment." }, "mergeSourceCommitments": { -"description": "List of source commitments to be merged into a new commitment.", +"description": "The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.", "items": { "type": "string" }, "type": "array" }, "name": { -"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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.", +"description": "Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "plan": { -"description": "The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).", +"description": "The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).", "enum": [ "INVALID", "THIRTY_SIX_MONTH", @@ -53396,11 +53458,11 @@ false "type": "string" }, "region": { -"description": "[Output Only] URL of the region where this commitment may be used.", +"description": "[Output Only] URL of the region where the commitment and committed resources are located.", "type": "string" }, "reservations": { -"description": "List of create-on-create reservations for this commitment.", +"description": "The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.", "items": { "$ref": "Reservation" }, @@ -53411,7 +53473,7 @@ false "description": "[Output Only] Status information for Commitment resource." }, "resources": { -"description": "A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.", +"description": "The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.", "items": { "$ref": "ResourceCommitment" }, @@ -53426,7 +53488,7 @@ false "type": "string" }, "splitSourceCommitment": { -"description": "Source commitment to be split into a new commitment.", +"description": "The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.", "type": "string" }, "startTimestamp": { @@ -53434,7 +53496,7 @@ false "type": "string" }, "status": { -"description": "[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.", +"description": "[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED.", "enum": [ "ACTIVE", "CANCELED_EARLY_TERMINATION", @@ -53460,7 +53522,7 @@ false "type": "string" }, "type": { -"description": "The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.", +"description": "The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series.", "enum": [ "ACCELERATOR_OPTIMIZED", "ACCELERATOR_OPTIMIZED_A3", @@ -53517,7 +53579,7 @@ false "", "", "", -"" +"Note for internal users: When adding a new enum Type for v1, make sure to also add it in the comment for the `optional Type type` definition. This ensures that the public documentation displays the new enum Type." ], "type": "string" } @@ -53886,7 +53948,7 @@ false "id": "CommitmentsScopedList", "properties": { "commitments": { -"description": "[Output Only] A list of commitments contained in this scope.", +"description": "[Output Only] The list of commitments contained in this scope.", "items": { "$ref": "Commitment" }, @@ -64316,7 +64378,7 @@ false "description": "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." }, "onFailedHealthCheck": { -"description": "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. ", +"description": "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. ", "enum": [ "DEFAULT_ACTION", "DO_NOTHING", @@ -68599,7 +68661,7 @@ false "IF_MACSEC" ], "enumDescriptions": [ -"Cross Site Networking", +"Cross-Site Networking", "Media Access Control security (MACsec)" ], "type": "string" @@ -68761,7 +68823,7 @@ false "IF_MACSEC" ], "enumDescriptions": [ -"Cross Site Networking", +"Cross-Site Networking", "Media Access Control security (MACsec)" ], "type": "string" @@ -69853,6 +69915,15 @@ false "InterconnectAttachmentGroupsOperationalStatus": { "id": "InterconnectAttachmentGroupsOperationalStatus", "properties": { +"attachmentStatuses": { +"items": { +"$ref": "InterconnectAttachmentGroupsOperationalStatusAttachmentStatus" +}, +"type": "array" +}, +"configured": { +"$ref": "InterconnectAttachmentGroupConfigured" +}, "groupStatus": { "description": "Summarizes the status of the group.", "enum": [ @@ -69868,6 +69939,80 @@ false "" ], "type": "string" +}, +"intent": { +"$ref": "InterconnectAttachmentGroupIntent" +}, +"operational": { +"$ref": "InterconnectAttachmentGroupConfigured", +"description": "The operational state of the group, including only active Attachments." +} +}, +"type": "object" +}, +"InterconnectAttachmentGroupsOperationalStatusAttachmentStatus": { +"description": "The status of one Attachment in the group. List order is arbitrary.", +"id": "InterconnectAttachmentGroupsOperationalStatusAttachmentStatus", +"properties": { +"adminEnabled": { +"description": "Whether this Attachment is enabled. This becomes false when the customer drains their Attachment.", +"type": "boolean" +}, +"attachment": { +"description": "The URL of the Attachment being described.", +"type": "string" +}, +"isActive": { +"description": "Whether this Attachment is participating in the redundant configuration. This will be ACTIVE if and only if the status below is CONNECTION_UP. Any INACTIVE Attachments are excluded from the analysis that generates operational.availabilitySLA.", +"enum": [ +"ACTIVE", +"INACTIVE", +"UNSPECIFIED" +], +"enumDescriptions": [ +"", +"", +"" +], +"type": "string" +}, +"status": { +"description": "Whether this Attachment is active, and if so, whether BGP is up. This is based on the statuses available in the Pantheon UI here: http://google3/java/com/google/cloud/boq/clientapi/gce/hybrid/api/interconnect_models.proto", +"enum": [ +"ATTACHMENT_STATUS_UNKNOWN", +"CONNECTION_DISABLED", +"CONNECTION_DOWN", +"CONNECTION_UP", +"DEFUNCT", +"IPSEC_CONFIGURATION_NEEDED_STATUS", +"IPSET_READY_TO_RESUME_FLOW_STATUS", +"IPV4_DOWN_IPV6_UP", +"IPV4_UP_IPV6_DOWN", +"PARTNER_REQUEST_RECEIVED", +"PENDING_CUSTOMER", +"PENDING_PARTNER", +"PROVISIONED", +"ROUTER_CONFIGURATION_BROKEN", +"UNPROVISIONED" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" +], +"type": "string" } }, "type": "object" @@ -70735,6 +70880,145 @@ false }, "type": "object" }, +"InterconnectGroupsCreateMembers": { +"id": "InterconnectGroupsCreateMembers", +"properties": { +"intentMismatchBehavior": { +"description": "How to behave when configured.topologyCapability.supportedSLA would not equal intent.topologyCapability after this call.", +"enum": [ +"CREATE", +"REJECT", +"UNSPECIFIED" +], +"enumDescriptions": [ +"", +"", +"" +], +"type": "string" +}, +"interconnects": { +"items": { +"$ref": "InterconnectGroupsCreateMembersInterconnectInput" +}, +"type": "array" +}, +"templateInterconnect": { +"$ref": "InterconnectGroupsCreateMembersInterconnectInput", +"description": "Parameters for the Interconnects to create." +} +}, +"type": "object" +}, +"InterconnectGroupsCreateMembersInterconnectInput": { +"description": "LINT.IfChange", +"id": "InterconnectGroupsCreateMembersInterconnectInput", +"properties": { +"adminEnabled": { +"description": "Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.", +"type": "boolean" +}, +"customerName": { +"description": "Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.", +"type": "string" +}, +"description": { +"description": "An optional description of this resource. Provide this property when you create the resource.", +"type": "string" +}, +"facility": { +"description": "A zone-free location to use for all Interconnects created in this call, like \"iad-1234\".", +"type": "string" +}, +"interconnectType": { +"description": "Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.", +"enum": [ +"DEDICATED", +"IT_PRIVATE", +"PARTNER" +], +"enumDescriptions": [ +"A dedicated physical interconnection with the customer.", +"[Deprecated] A private, physical interconnection with the customer.", +"A partner-managed interconnection shared between customers via partner." +], +"type": "string" +}, +"linkType": { +"description": "Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.", +"enum": [ +"LINK_TYPE_ETHERNET_100G_LR", +"LINK_TYPE_ETHERNET_10G_LR" +], +"enumDescriptions": [ +"100G Ethernet, LR Optics.", +"10G Ethernet, LR Optics. [(rate_bps) = 10000000000];" +], +"type": "string" +}, +"name": { +"annotations": { +"required": [ +"compute.interconnects.insert" +] +}, +"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"nocContactEmail": { +"description": "Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.", +"type": "string" +}, +"remoteLocation": { +"description": "Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.", +"type": "string" +}, +"requestedFeatures": { +"description": "Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.", +"items": { +"enum": [ +"IF_CROSS_SITE_NETWORK", +"IF_MACSEC" +], +"enumDescriptions": [ +"Cross-Site Networking", +"Media Access Control security (MACsec)" +], +"type": "string" +}, +"type": "array" +}, +"requestedLinkCount": { +"description": "Target number of physical links in the link bundle, as requested by the customer.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"InterconnectGroupsCreateMembersRequest": { +"id": "InterconnectGroupsCreateMembersRequest", +"properties": { +"request": { +"$ref": "InterconnectGroupsCreateMembers" +} +}, +"type": "object" +}, +"InterconnectGroupsCreateMembersResponse": { +"description": "Response for the InterconnectGroupsCreateMembersRequest.", +"id": "InterconnectGroupsCreateMembersResponse", +"properties": { +"etag": { +"type": "string" +}, +"result": { +"$ref": "InterconnectGroup" +} +}, +"type": "object" +}, "InterconnectGroupsGetOperationalStatusResponse": { "description": "Response for the InterconnectGroupsGetOperationalStatusResponse.", "id": "InterconnectGroupsGetOperationalStatusResponse", @@ -71160,7 +71444,7 @@ false "IF_MACSEC" ], "enumDescriptions": [ -"Cross Site Networking", +"Cross-Site Networking", "Media Access Control security (MACsec)" ], "type": "string" @@ -72675,16 +72959,16 @@ false "id": "LicenseResourceCommitment", "properties": { "amount": { -"description": "The number of licenses purchased.", +"description": "The number of licenses you plan to purchase.", "format": "int64", "type": "string" }, "coresPerLicense": { -"description": "Specifies the core range of the instance for which this license applies.", +"description": "The number of cores per license.", "type": "string" }, "license": { -"description": "Any applicable license URI.", +"description": "The applicable license URI.", "type": "string" } }, @@ -73170,6 +73454,10 @@ false "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, +"params": { +"$ref": "MachineImageParams", +"description": "Input only. [Input Only] Additional parameters that are passed in the request, but are not persisted in the resource." +}, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -73397,6 +73685,27 @@ false }, "type": "object" }, +"MachineImageParams": { +"description": "Machine Image parameters", +"id": "MachineImageParams", +"properties": { +"excludedDisks": { +"description": "Input only. [Input Only] Specifies the list of disk device names that must be excluded from the new machine image.", +"items": { +"type": "string" +}, +"type": "array" +}, +"includedDisks": { +"description": "Input only. [Input Only] Specifies the list of disk device names that must be included with the new machine image.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "MachineType": { "description": "Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types.", "id": "MachineType", @@ -77528,10 +77837,6 @@ false "selfLinkWithId": { "description": "[Output Only] Server-defined URL for this resource with the resource id.", "type": "string" -}, -"zone": { -"description": "[Output Only] Zone to which the network is restricted.", -"type": "string" } }, "type": "object" @@ -85468,7 +85773,7 @@ false "id": "RegionCommitmentsUpdateReservationsRequest", "properties": { "reservations": { -"description": "A list of two reservations to transfer GPUs and local SSD between.", +"description": "A list of two reservations to transfer GPUs and Local SSD disks between.", "items": { "$ref": "Reservation" }, @@ -88103,20 +88408,20 @@ false "type": "object" }, "ResourceCommitment": { -"description": "Commitment for a particular resource (a Commitment is composed of one or more of these).", +"description": "Commitment for a particular hardware resource (a commitment is composed of one or more of these).", "id": "ResourceCommitment", "properties": { "acceleratorType": { -"description": "Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.", +"description": "Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR.", "type": "string" }, "amount": { -"description": "The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.", +"description": "The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. ", "format": "int64", "type": "string" }, "type": { -"description": "Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR.", +"description": "The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type.", "enum": [ "ACCELERATOR", "LOCAL_SSD", @@ -88962,6 +89267,10 @@ false "description": "Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty.", "type": "object" }, +"region": { +"description": "Region where the snapshot is scoped to.", +"type": "string" +}, "storageLocations": { "description": "Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional).", "items": { @@ -89062,6 +89371,22 @@ false "description": "Represents the workload policy.", "id": "ResourcePolicyWorkloadPolicy", "properties": { +"acceleratorTopology": { +"type": "string" +}, +"maxTopologyDistance": { +"enum": [ +"BLOCK", +"CLUSTER", +"SUBBLOCK" +], +"enumDescriptions": [ +"VMs must be provisioned in the same block.", +"VMs must be provisioned in the same cluster.", +"VMs must be provisioned in the same subblock." +], +"type": "string" +}, "type": { "enum": [ "HIGH_AVAILABILITY", @@ -90504,7 +90829,7 @@ false "id": "RouterInterface", "properties": { "ipRange": { -"description": "IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. ", +"description": "IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. ", "type": "string" }, "ipVersion": { @@ -95763,6 +96088,20 @@ false }, "description": "List of regions that can restore a regional snapshot from the current region", "type": "object" +}, +"policy": { +"description": "Policy of which location is allowed to access snapshot.", +"enum": [ +"ALL_REGIONS", +"POLICY_UNSPECIFIED", +"SPECIFIC_REGIONS" +], +"enumDescriptions": [ +"Any regions will be able to access the source location.", +"", +"Only allowlisted regions will be able to restore region scoped snapshots" +], +"type": "string" } }, "type": "object" @@ -106090,6 +106429,10 @@ false "description": "Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview.", "id": "VpnTunnel", "properties": { +"cipherSuite": { +"$ref": "VpnTunnelCipherSuite", +"description": "User specified list of ciphers to use for the phase 1 and phase 2 of the IKE protocol." +}, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" @@ -106402,6 +106745,18 @@ false }, "type": "object" }, +"VpnTunnelCipherSuite": { +"id": "VpnTunnelCipherSuite", +"properties": { +"phase1": { +"$ref": "VpnTunnelPhase1Algorithms" +}, +"phase2": { +"$ref": "VpnTunnelPhase2Algorithms" +} +}, +"type": "object" +}, "VpnTunnelList": { "description": "Contains a list of VpnTunnel resources.", "id": "VpnTunnelList", @@ -106557,6 +106912,60 @@ false }, "type": "object" }, +"VpnTunnelPhase1Algorithms": { +"id": "VpnTunnelPhase1Algorithms", +"properties": { +"dh": { +"items": { +"type": "string" +}, +"type": "array" +}, +"encryption": { +"items": { +"type": "string" +}, +"type": "array" +}, +"integrity": { +"items": { +"type": "string" +}, +"type": "array" +}, +"prf": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"VpnTunnelPhase2Algorithms": { +"id": "VpnTunnelPhase2Algorithms", +"properties": { +"encryption": { +"items": { +"type": "string" +}, +"type": "array" +}, +"integrity": { +"items": { +"type": "string" +}, +"type": "array" +}, +"pfs": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "VpnTunnelsScopedList": { "id": "VpnTunnelsScopedList", "properties": { diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index 79f36358011..173af10519f 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -710,6 +710,47 @@ } } }, +"advice": { +"methods": { +"calendarMode": { +"description": "Advise how, where and when to create the requested amount of instances with specified accelerators, within the specified time and location limits. The method recommends creating future reservations for the requested resources.", +"flatPath": "projects/{project}/regions/{region}/advice/calendarMode", +"httpMethod": "POST", +"id": "compute.advice.calendarMode", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"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" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/advice/calendarMode", +"request": { +"$ref": "CalendarModeAdviceRequest" +}, +"response": { +"$ref": "CalendarModeAdviceResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +} +} +}, "autoscalers": { "methods": { "aggregatedList": { @@ -23618,7 +23659,7 @@ ] }, "update": { -"description": "Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.", +"description": "Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be updated: auto_renew and plan.", "flatPath": "projects/{project}/regions/{region}/commitments/{commitment}", "httpMethod": "PATCH", "id": "compute.regionCommitments.update", @@ -23629,7 +23670,7 @@ ], "parameters": { "commitment": { -"description": "Name of the commitment for which auto renew is being updated.", +"description": "Name of the commitment that you want to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -23679,7 +23720,7 @@ ] }, "updateReservations": { -"description": "Transfers GPUs or local SSDs between reservations within commitments.", +"description": "Transfers GPUs or Local SSD disks between reservations that are attached to the same commitment.", "flatPath": "projects/{project}/regions/{region}/commitments/{commitment}/updateReservations", "httpMethod": "POST", "id": "compute.regionCommitments.updateReservations", @@ -23690,7 +23731,7 @@ ], "parameters": { "commitment": { -"description": "Name of the commitment for which the reservation is being updated.", +"description": "Name of the commitment for which the reservations are being updated.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -32499,6 +32540,62 @@ "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] +}, +"performMaintenance": { +"description": "Allows customers to perform maintenance on a reservation block", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}/performMaintenance", +"httpMethod": "POST", +"id": "compute.reservationBlocks.performMaintenance", +"parameterOrder": [ +"project", +"zone", +"reservation", +"reservationBlock" +], +"parameters": { +"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 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).", +"location": "query", +"type": "string" +}, +"reservation": { +"description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"reservationBlock": { +"description": "The name of the reservation block. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"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}/reservations/{reservation}/reservationBlocks/{reservationBlock}/performMaintenance", +"request": { +"$ref": "ReservationsBlocksPerformMaintenanceRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] } } }, @@ -32814,6 +32911,54 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"performMaintenance": { +"description": "Perform maintenance on an extended reservation", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/performMaintenance", +"httpMethod": "POST", +"id": "compute.reservations.performMaintenance", +"parameterOrder": [ +"project", +"zone", +"reservation" +], +"parameters": { +"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 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).", +"location": "query", +"type": "string" +}, +"reservation": { +"description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"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}/reservations/{reservation}/performMaintenance", +"request": { +"$ref": "ReservationsPerformMaintenanceRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "resize": { "description": "Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations.", "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/resize", @@ -42856,7 +43001,7 @@ } } }, -"revision": "20250119", +"revision": "20250126", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -47937,6 +48082,48 @@ false }, "type": "object" }, +"CalendarModeAdviceRequest": { +"description": "A request to recommend the best way to consume the specified resources in the future.", +"id": "CalendarModeAdviceRequest", +"properties": { +"futureResourcesSpecs": { +"additionalProperties": { +"$ref": "FutureResourcesSpec" +}, +"description": "Specification of resources to create in the future. The key of the map is an arbitrary string specified by the caller. Value of the map is a specification of required resources and their constraints. Currently only one value is allowed in this map.", +"type": "object" +} +}, +"type": "object" +}, +"CalendarModeAdviceResponse": { +"description": "A response containing the recommended way of creating the specified resources in the future. It contains (will contain) multiple recommendations that can be analyzed by the customer and the best one can be picked.", +"id": "CalendarModeAdviceResponse", +"properties": { +"recommendations": { +"description": "Recommendations where, how and when to create the requested resources in order to maximize their obtainability and minimize cost.", +"items": { +"$ref": "CalendarModeRecommendation" +}, +"type": "array" +} +}, +"type": "object" +}, +"CalendarModeRecommendation": { +"description": "A single recommendation to create requested resources. Contains detailed recommendations for every future resources specification specified in CalendarModeAdviceRequest.", +"id": "CalendarModeRecommendation", +"properties": { +"recommendationsPerSpec": { +"additionalProperties": { +"$ref": "FutureResourcesRecommendation" +}, +"description": "Recommendations for every future resource specification passed in CalendarModeAdviceRequest. Keys of the map correspond to keys specified in the request.", +"type": "object" +} +}, +"type": "object" +}, "CircuitBreakers": { "description": "Settings controlling the volume of requests, connections and retries to this backend service.", "id": "CircuitBreakers", @@ -47974,15 +48161,15 @@ false "type": "object" }, "Commitment": { -"description": "Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts.", +"description": "Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts", "id": "Commitment", "properties": { "autoRenew": { -"description": "Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.", +"description": "Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027.", "type": "boolean" }, "category": { -"description": "The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.", +"description": "The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to.", "enum": [ "CATEGORY_UNSPECIFIED", "LICENSE", @@ -48000,11 +48187,11 @@ false "type": "string" }, "customEndTimestamp": { -"description": "[Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.", +"description": "[Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration.", "type": "string" }, "description": { -"description": "An optional description of this resource. Provide this property when you create the resource.", +"description": "An optional description of the commitment. You can provide this property when you create the resource.", "type": "string" }, "endTimestamp": { @@ -48012,7 +48199,6 @@ false "type": "string" }, "existingReservations": { -"description": "Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation ", "items": { "type": "string" }, @@ -48033,19 +48219,19 @@ false "description": "The license specification required as part of a license commitment." }, "mergeSourceCommitments": { -"description": "List of source commitments to be merged into a new commitment.", +"description": "The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.", "items": { "type": "string" }, "type": "array" }, "name": { -"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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.", +"description": "Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "plan": { -"description": "The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).", +"description": "The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).", "enum": [ "INVALID", "THIRTY_SIX_MONTH", @@ -48059,11 +48245,11 @@ false "type": "string" }, "region": { -"description": "[Output Only] URL of the region where this commitment may be used.", +"description": "[Output Only] URL of the region where the commitment and committed resources are located.", "type": "string" }, "reservations": { -"description": "List of create-on-create reservations for this commitment.", +"description": "The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.", "items": { "$ref": "Reservation" }, @@ -48074,7 +48260,7 @@ false "description": "[Output Only] Status information for Commitment resource." }, "resources": { -"description": "A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.", +"description": "The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.", "items": { "$ref": "ResourceCommitment" }, @@ -48085,7 +48271,7 @@ false "type": "string" }, "splitSourceCommitment": { -"description": "Source commitment to be split into a new commitment.", +"description": "The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.", "type": "string" }, "startTimestamp": { @@ -48093,7 +48279,7 @@ false "type": "string" }, "status": { -"description": "[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.", +"description": "[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED.", "enum": [ "ACTIVE", "CANCELLED", @@ -48115,7 +48301,7 @@ false "type": "string" }, "type": { -"description": "The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.", +"description": "The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series.", "enum": [ "ACCELERATOR_OPTIMIZED", "ACCELERATOR_OPTIMIZED_A3", @@ -48168,7 +48354,7 @@ false "", "", "", -"" +"Note for internal users: When adding a new enum Type for v1, make sure to also add it in the comment for the `optional Type type` definition. This ensures that the public documentation displays the new enum Type." ], "type": "string" } @@ -48507,7 +48693,7 @@ false "id": "CommitmentsScopedList", "properties": { "commitments": { -"description": "[Output Only] A list of commitments contained in this scope.", +"description": "[Output Only] The list of commitments contained in this scope.", "items": { "$ref": "Commitment" }, @@ -52007,6 +52193,37 @@ false }, "type": "object" }, +"FlexibleTimeRange": { +"description": "A flexible specification of a time range that has 3 points of flexibility: (1) a flexible start time, (2) a flexible end time, (3) a flexible duration. It is possible to specify a contradictory time range that cannot be matched by any Interval. This causes a validation error.", +"id": "FlexibleTimeRange", +"properties": { +"endTimeNotEarlierThan": { +"format": "google-datetime", +"type": "string" +}, +"endTimeNotLaterThan": { +"format": "google-datetime", +"type": "string" +}, +"maxDuration": { +"format": "google-duration", +"type": "string" +}, +"minDuration": { +"format": "google-duration", +"type": "string" +}, +"startTimeNotEarlierThan": { +"format": "google-datetime", +"type": "string" +}, +"startTimeNotLaterThan": { +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "ForwardingRule": { "description": "Represents a Forwarding Rule resource. Forwarding rule resources in Google Cloud can be either regional or global in scope: * [Global](https://cloud.google.com/compute/docs/reference/rest/beta/globalForwardingRules) * [Regional](https://cloud.google.com/compute/docs/reference/rest/beta/forwardingRules) A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway). For more information, read Forwarding rule concepts and Using protocol forwarding.", "id": "ForwardingRule", @@ -53612,6 +53829,246 @@ false }, "type": "object" }, +"FutureResourcesRecommendation": { +"description": "Recommendation for single resources specification, to be created in the future.", +"id": "FutureResourcesRecommendation", +"properties": { +"endTime": { +"format": "google-datetime", +"type": "string" +}, +"location": { +"description": "The advised location for resource usage. When a zone, in format 'zones/'. If not set, it means that no location is recommended - see other_locations for details.", +"type": "string" +}, +"otherLocations": { +"additionalProperties": { +"$ref": "FutureResourcesRecommendationOtherLocation" +}, +"description": "List of locations in the request scope that were not recommended. Keys of the map are zones, in format 'zones/'. The values are status information indicating the recommendation status.", +"type": "object" +}, +"recommendationId": { +"description": "Unique id of the recommendation, a UUID string generated by the API.", +"type": "string" +}, +"recommendationType": { +"description": "Type of recommendation. Currently only FUTURE_RESERVATION is supported.", +"enum": [ +"FUTURE_RESERVATION", +"RECOMMENDATION_TYPE_UNSPECIFIED" +], +"enumDescriptions": [ +"A Future Reservation is recommended.", +"Default value, unused." +], +"type": "string" +}, +"startTime": { +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"FutureResourcesRecommendationOtherLocation": { +"description": "Information about recommendation status for locations that were allowed but not used by the response.", +"id": "FutureResourcesRecommendationOtherLocation", +"properties": { +"details": { +"description": "Details (human readable) describing the situation. For example, if status is CONDITION_NOT_MET, then details contain information about the parameters of the time window that did not meet the required conditions.", +"type": "string" +}, +"status": { +"description": "Status of recommendation in this location.", +"enum": [ +"CONDITIONS_NOT_MET", +"NOT_SUPPORTED", +"NO_CAPACITY", +"OTHER_LOCATION_STATUS_UNDEFINED", +"RECOMMENDED" +], +"enumDescriptions": [ +"The requested resources are offered in this location but the requested time window is does not meet the required conditions.", +"The requested resources are not offered in this location. Retrying the request will not change this status.", +"The requested resources are offered in this location and the requested time window is accepted but there is no capacity within the requested time window.", +"Default value, unused.", +"The requested resources are offered in this location and it is possible to request them. However, another location was better and was recommended." +], +"type": "string" +} +}, +"type": "object" +}, +"FutureResourcesSpec": { +"description": "Specification of resources to be created at some time in the future within an optionally specified set of locations, and within the specified time range.", +"id": "FutureResourcesSpec", +"properties": { +"deploymentType": { +"description": "Indicates if the reservation allocation strategy is static (DENSE) or dynamic (STANDARD). Defaults to DENSE.", +"enum": [ +"DENSE", +"DEPLOYMENT_TYPE_UNSPECIFIED", +"FLEXIBLE" +], +"enumDescriptions": [ +"The reserved capacity is made up of densely deployed reservation blocks.", +"", +"The reserved capacity is made up of highly flexible, logical reservation blocks." +], +"type": "string" +}, +"locationPolicy": { +"$ref": "FutureResourcesSpecLocationPolicy", +"description": "Optional location policy allowing to exclude some zone(s) in which the resources must not be created." +}, +"targetResources": { +"$ref": "FutureResourcesSpecTargetResources", +"description": "Specification of the reserved resources." +}, +"timeRangeSpec": { +"$ref": "FlexibleTimeRange", +"description": "Specification of a time range in which the resources may be created. The time range specifies start of resource use and planned end of resource use." +} +}, +"type": "object" +}, +"FutureResourcesSpecAggregateResources": { +"id": "FutureResourcesSpecAggregateResources", +"properties": { +"acceleratorCount": { +"description": "Size of the request, in accelerator (chip) count.", +"format": "int64", +"type": "string" +}, +"vmFamily": { +"description": "The VM family that all instances scheduled against this reservation must belong to. Use for TPU reservations.", +"enum": [ +"VM_FAMILY_CLOUD_TPU_DEVICE_CT3", +"VM_FAMILY_CLOUD_TPU_LITE_DEVICE_CT5L", +"VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT5LP", +"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P", +"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P" +], +"enumDescriptions": [ +"", +"", +"", +"", +"" +], +"type": "string" +}, +"workloadType": { +"description": "Workload type. Use for TPU reservations.", +"enum": [ +"BATCH", +"SERVING", +"UNSPECIFIED" +], +"enumDescriptions": [ +"Reserved resources will be optimized for BATCH workloads, such as ML training.", +"Reserved resources will be optimized for SERVING workloads, such as ML inference.", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"FutureResourcesSpecLocalSsdPartition": { +"id": "FutureResourcesSpecLocalSsdPartition", +"properties": { +"diskInterface": { +"description": "Disk interface. Defaults to SCSI.", +"enum": [ +"NVME", +"SCSI" +], +"enumDescriptions": [ +"", +"" +], +"type": "string" +}, +"diskSizeGb": { +"description": "The size of the disk in GB.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"FutureResourcesSpecLocationPolicy": { +"description": "Specification of locations to create resources in.", +"id": "FutureResourcesSpecLocationPolicy", +"properties": { +"locations": { +"additionalProperties": { +"$ref": "FutureResourcesSpecLocationPolicyLocation" +}, +"description": "Preferences for specified locations. Keys of the map are locations - zones, in format of 'zones/'. Values are preferences for the zones. If a zone is not specified in this map, it is ALLOWed.", +"type": "object" +} +}, +"type": "object" +}, +"FutureResourcesSpecLocationPolicyLocation": { +"description": "Preference for a single specified location.", +"id": "FutureResourcesSpecLocationPolicyLocation", +"properties": { +"preference": { +"description": "Preference for this location.", +"enum": [ +"ALLOW", +"DENY", +"PREFERENCE_UNSPECIFIED" +], +"enumDescriptions": [ +"Location is allowed for use.", +"Location is prohibited.", +"Default value, unused." +], +"type": "string" +} +}, +"type": "object" +}, +"FutureResourcesSpecSpecificSKUResources": { +"id": "FutureResourcesSpecSpecificSKUResources", +"properties": { +"instanceCount": { +"description": "Size of the request, in instance count.", +"format": "int64", +"type": "string" +}, +"localSsdPartitions": { +"description": "Local SSD partitions. You do not have to include SSD partitions that are built in the machine type.", +"items": { +"$ref": "FutureResourcesSpecLocalSsdPartition" +}, +"type": "array" +}, +"machineType": { +"description": "The machine type to use for instances that will use the reservation. This field only accepts machine type names. e.g. n2-standard-4 and does not accept machine type full or partial url. e.g. projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4. Use for GPU reservations.", +"type": "string" +} +}, +"type": "object" +}, +"FutureResourcesSpecTargetResources": { +"description": "Specification of reserved resources.", +"id": "FutureResourcesSpecTargetResources", +"properties": { +"aggregateResources": { +"$ref": "FutureResourcesSpecAggregateResources" +}, +"specificSkuResources": { +"$ref": "FutureResourcesSpecSpecificSKUResources" +} +}, +"type": "object" +}, "GRPCHealthCheck": { "id": "GRPCHealthCheck", "properties": { @@ -57762,6 +58219,20 @@ false "" ], "type": "string" +}, +"onFailedHealthCheck": { +"description": "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. ", +"enum": [ +"DEFAULT_ACTION", +"DO_NOTHING", +"REPAIR" +], +"enumDescriptions": [ +"(Default) MIG uses the same action configured for instanceLifecyclePolicy.defaultActionOnFailure field.", +"MIG doesn't repair an unhealthy VM.", +"MIG automatically repairs an unhealthy VM by recreating it." +], +"type": "string" } }, "type": "object" @@ -61682,9 +62153,11 @@ false "description": "[Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails.", "items": { "enum": [ +"IF_CROSS_SITE_NETWORK", "IF_MACSEC" ], "enumDescriptions": [ +"Cross-Site Networking", "Media Access Control security (MACsec)" ], "type": "string" @@ -61835,9 +62308,11 @@ false "description": "Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.", "items": { "enum": [ +"IF_CROSS_SITE_NETWORK", "IF_MACSEC" ], "enumDescriptions": [ +"Cross-Site Networking", "Media Access Control security (MACsec)" ], "type": "string" @@ -61868,6 +62343,13 @@ false "The interconnect has not completed turnup. No attachments may be provisioned on this interconnect." ], "type": "string" +}, +"wireGroups": { +"description": "[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.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -63126,9 +63608,11 @@ false "description": "[Output only] List of features available at this InterconnectLocation, which can take one of the following values: - IF_MACSEC ", "items": { "enum": [ +"IF_CROSS_SITE_NETWORK", "IF_MACSEC" ], "enumDescriptions": [ +"Cross-Site Networking", "Media Access Control security (MACsec)" ], "type": "string" @@ -64085,16 +64569,16 @@ false "id": "LicenseResourceCommitment", "properties": { "amount": { -"description": "The number of licenses purchased.", +"description": "The number of licenses you plan to purchase.", "format": "int64", "type": "string" }, "coresPerLicense": { -"description": "Specifies the core range of the instance for which this license applies.", +"description": "The number of cores per license.", "type": "string" }, "license": { -"description": "Any applicable license URI.", +"description": "The applicable license URI.", "type": "string" } }, @@ -68448,10 +68932,6 @@ false "selfLinkWithId": { "description": "[Output Only] Server-defined URL for this resource with the resource id.", "type": "string" -}, -"zone": { -"description": "[Output Only] Zone to which the network is restricted.", -"type": "string" } }, "type": "object" @@ -70691,6 +71171,11 @@ false "format": "int32", "type": "integer" }, +"maxVms": { +"description": "[Output Only] Maximum number of VMs that can be created for this node type.", +"format": "int32", +"type": "integer" +}, "memoryMb": { "description": "[Output Only] The amount of physical memory available to the node type, defined in MB.", "format": "int32", @@ -75177,7 +75662,7 @@ false "id": "RegionCommitmentsUpdateReservationsRequest", "properties": { "reservations": { -"description": "A list of two reservations to transfer GPUs and local SSD between.", +"description": "A list of two reservations to transfer GPUs and Local SSD disks between.", "items": { "$ref": "Reservation" }, @@ -77554,6 +78039,50 @@ false }, "type": "object" }, +"ReservationsBlocksPerformMaintenanceRequest": { +"id": "ReservationsBlocksPerformMaintenanceRequest", +"properties": { +"maintenanceScope": { +"description": "Specifies if all, running or unused hosts are in scope for this request.", +"enum": [ +"ALL", +"MAINTENANCE_SCOPE_UNSPECIFIED", +"RUNNING_VMS", +"UNUSED_CAPACITY" +], +"enumDescriptions": [ +"Trigger maintenance for all hosts belonging to this reservation irrespective of whether VMs are running on them or not.", +"Internal only", +"Trigger maintenance only on the hosts belonging to this reservation which have VMs running on them.", +"Trigger maintenance only on the hosts belonging to this reservation which do not have any VMs running on them. This is not allowed for Standard ExR" +], +"type": "string" +} +}, +"type": "object" +}, +"ReservationsPerformMaintenanceRequest": { +"id": "ReservationsPerformMaintenanceRequest", +"properties": { +"maintenanceScope": { +"description": "Specifies if all, running or unused hosts are in scope for this request.", +"enum": [ +"ALL", +"MAINTENANCE_SCOPE_UNSPECIFIED", +"RUNNING_VMS", +"UNUSED_CAPACITY" +], +"enumDescriptions": [ +"Trigger maintenance for all hosts belonging to this reservation irrespective of whether VMs are running on them or not.", +"Internal only", +"Trigger maintenance only on the hosts belonging to this reservation which have VMs running on them.", +"Trigger maintenance only on the hosts belonging to this reservation which do not have any VMs running on them. This is not allowed for Standard ExR" +], +"type": "string" +} +}, +"type": "object" +}, "ReservationsResizeRequest": { "id": "ReservationsResizeRequest", "properties": { @@ -77703,20 +78232,20 @@ false "type": "object" }, "ResourceCommitment": { -"description": "Commitment for a particular resource (a Commitment is composed of one or more of these).", +"description": "Commitment for a particular hardware resource (a commitment is composed of one or more of these).", "id": "ResourceCommitment", "properties": { "acceleratorType": { -"description": "Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.", +"description": "Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR.", "type": "string" }, "amount": { -"description": "The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.", +"description": "The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. ", "format": "int64", "type": "string" }, "type": { -"description": "Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR.", +"description": "The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type.", "enum": [ "ACCELERATOR", "LOCAL_SSD", @@ -79793,7 +80322,7 @@ false "id": "RouterInterface", "properties": { "ipRange": { -"description": "IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. ", +"description": "IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. ", "type": "string" }, "ipVersion": { diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index 29cef7cf5fa..7ae09675f95 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -15829,6 +15829,60 @@ "https://www.googleapis.com/auth/compute" ] }, +"addPacketMirroringRule": { +"description": "Inserts a packet mirroring rule into a firewall policy.", +"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule", +"httpMethod": "POST", +"id": "compute.networkFirewallPolicies.addPacketMirroringRule", +"parameterOrder": [ +"project", +"firewallPolicy" +], +"parameters": { +"firewallPolicy": { +"description": "Name of the firewall policy to update.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"maxPriority": { +"description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"minPriority": { +"description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"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 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).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule", +"request": { +"$ref": "FirewallPolicyRule" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "addRule": { "description": "Inserts a rule into a firewall policy.", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule", @@ -16148,6 +16202,47 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"getPacketMirroringRule": { +"description": "Gets a packet mirroring rule of the specified priority.", +"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule", +"httpMethod": "GET", +"id": "compute.networkFirewallPolicies.getPacketMirroringRule", +"parameterOrder": [ +"project", +"firewallPolicy" +], +"parameters": { +"firewallPolicy": { +"description": "Name of the firewall policy to which the queried rule belongs.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"priority": { +"description": "The priority of the rule to get from the firewall policy.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"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" +} +}, +"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule", +"response": { +"$ref": "FirewallPolicyRule" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "getRule": { "description": "Gets a rule of the specified priority.", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule", @@ -16320,6 +16415,54 @@ "https://www.googleapis.com/auth/compute" ] }, +"patchPacketMirroringRule": { +"description": "Patches a packet mirroring rule of the specified priority.", +"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule", +"httpMethod": "POST", +"id": "compute.networkFirewallPolicies.patchPacketMirroringRule", +"parameterOrder": [ +"project", +"firewallPolicy" +], +"parameters": { +"firewallPolicy": { +"description": "Name of the firewall policy to update.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"priority": { +"description": "The priority of the rule to patch.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"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 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).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule", +"request": { +"$ref": "FirewallPolicyRule" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "patchRule": { "description": "Patches a rule of the specified priority.", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule", @@ -16412,6 +16555,51 @@ "https://www.googleapis.com/auth/compute" ] }, +"removePacketMirroringRule": { +"description": "Deletes a packet mirroring rule of the specified priority.", +"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule", +"httpMethod": "POST", +"id": "compute.networkFirewallPolicies.removePacketMirroringRule", +"parameterOrder": [ +"project", +"firewallPolicy" +], +"parameters": { +"firewallPolicy": { +"description": "Name of the firewall policy to update.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"priority": { +"description": "The priority of the rule to remove from the firewall policy.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"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 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).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "removeRule": { "description": "Deletes a rule of the specified priority.", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule", @@ -21152,7 +21340,7 @@ ] }, "update": { -"description": "Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.", +"description": "Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be updated: auto_renew and plan.", "flatPath": "projects/{project}/regions/{region}/commitments/{commitment}", "httpMethod": "PATCH", "id": "compute.regionCommitments.update", @@ -21163,7 +21351,7 @@ ], "parameters": { "commitment": { -"description": "Name of the commitment for which auto renew is being updated.", +"description": "Name of the commitment that you want to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -38015,7 +38203,7 @@ } } }, -"revision": "20250119", +"revision": "20250126", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -42787,15 +42975,15 @@ false "type": "object" }, "Commitment": { -"description": "Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts.", +"description": "Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts", "id": "Commitment", "properties": { "autoRenew": { -"description": "Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.", +"description": "Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027.", "type": "boolean" }, "category": { -"description": "The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.", +"description": "The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to.", "enum": [ "CATEGORY_UNSPECIFIED", "LICENSE", @@ -42813,11 +43001,11 @@ false "type": "string" }, "customEndTimestamp": { -"description": "[Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.", +"description": "[Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration.", "type": "string" }, "description": { -"description": "An optional description of this resource. Provide this property when you create the resource.", +"description": "An optional description of the commitment. You can provide this property when you create the resource.", "type": "string" }, "endTimestamp": { @@ -42825,7 +43013,6 @@ false "type": "string" }, "existingReservations": { -"description": "Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation ", "items": { "type": "string" }, @@ -42846,19 +43033,19 @@ false "description": "The license specification required as part of a license commitment." }, "mergeSourceCommitments": { -"description": "List of source commitments to be merged into a new commitment.", +"description": "The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.", "items": { "type": "string" }, "type": "array" }, "name": { -"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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.", +"description": "Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first 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.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "plan": { -"description": "The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).", +"description": "The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).", "enum": [ "INVALID", "THIRTY_SIX_MONTH", @@ -42872,11 +43059,11 @@ false "type": "string" }, "region": { -"description": "[Output Only] URL of the region where this commitment may be used.", +"description": "[Output Only] URL of the region where the commitment and committed resources are located.", "type": "string" }, "reservations": { -"description": "List of create-on-create reservations for this commitment.", +"description": "The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.", "items": { "$ref": "Reservation" }, @@ -42887,7 +43074,7 @@ false "description": "[Output Only] Status information for Commitment resource." }, "resources": { -"description": "A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.", +"description": "The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.", "items": { "$ref": "ResourceCommitment" }, @@ -42898,7 +43085,7 @@ false "type": "string" }, "splitSourceCommitment": { -"description": "Source commitment to be split into a new commitment.", +"description": "The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.", "type": "string" }, "startTimestamp": { @@ -42906,7 +43093,7 @@ false "type": "string" }, "status": { -"description": "[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.", +"description": "[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED.", "enum": [ "ACTIVE", "CANCELLED", @@ -42928,7 +43115,7 @@ false "type": "string" }, "type": { -"description": "The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.", +"description": "The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series.", "enum": [ "ACCELERATOR_OPTIMIZED", "ACCELERATOR_OPTIMIZED_A3", @@ -42981,7 +43168,7 @@ false "", "", "", -"" +"Note for internal users: When adding a new enum Type for v1, make sure to also add it in the comment for the `optional Type type` definition. This ensures that the public documentation displays the new enum Type." ], "type": "string" } @@ -43320,7 +43507,7 @@ false "id": "CommitmentsScopedList", "properties": { "commitments": { -"description": "[Output Only] A list of commitments contained in this scope.", +"description": "[Output Only] The list of commitments contained in this scope.", "items": { "$ref": "Commitment" }, @@ -46261,6 +46448,13 @@ false "description": "Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.", "type": "string" }, +"packetMirroringRules": { +"description": "A list of packet mirroring rules that belong to this policy.", +"items": { +"$ref": "FirewallPolicyRule" +}, +"type": "array" +}, "parent": { "description": "[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.", "type": "string" @@ -54244,6 +54438,13 @@ false "description": "[Output Only] The name of the firewall policy.", "type": "string" }, +"packetMirroringRules": { +"description": "[Output Only] The packet mirroring rules that apply to the instance.", +"items": { +"$ref": "FirewallPolicyRule" +}, +"type": "array" +}, "priority": { "description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", "format": "int32", @@ -57482,16 +57683,16 @@ false "id": "LicenseResourceCommitment", "properties": { "amount": { -"description": "The number of licenses purchased.", +"description": "The number of licenses you plan to purchase.", "format": "int64", "type": "string" }, "coresPerLicense": { -"description": "Specifies the core range of the instance for which this license applies.", +"description": "The number of cores per license.", "type": "string" }, "license": { -"description": "Any applicable license URI.", +"description": "The applicable license URI.", "type": "string" } }, @@ -61519,10 +61720,6 @@ false "selfLinkWithId": { "description": "[Output Only] Server-defined URL for this resource with the resource id.", "type": "string" -}, -"zone": { -"description": "[Output Only] Zone to which the network is restricted.", -"type": "string" } }, "type": "object" @@ -62138,6 +62335,13 @@ false "description": "[Output Only] The name of the firewall policy.", "type": "string" }, +"packetMirroringRules": { +"description": "[Output Only] The packet mirroring rules that apply to the network.", +"items": { +"$ref": "FirewallPolicyRule" +}, +"type": "array" +}, "priority": { "description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", "format": "int32", @@ -63727,6 +63931,11 @@ false "format": "int32", "type": "integer" }, +"maxVms": { +"description": "[Output Only] Maximum number of VMs that can be created for this node type.", +"format": "int32", +"type": "integer" +}, "memoryMb": { "description": "[Output Only] The amount of physical memory available to the node type, defined in MB.", "format": "int32", @@ -69462,6 +69671,13 @@ false "description": "[Output Only] The name of the firewall policy.", "type": "string" }, +"packetMirroringRules": { +"description": "[Output only] The packet mirroring rules that apply to the network.", +"items": { +"$ref": "FirewallPolicyRule" +}, +"type": "array" +}, "rules": { "description": "[Output only] The rules that apply to the network.", "items": { @@ -70158,20 +70374,20 @@ false "type": "object" }, "ResourceCommitment": { -"description": "Commitment for a particular resource (a Commitment is composed of one or more of these).", +"description": "Commitment for a particular hardware resource (a commitment is composed of one or more of these).", "id": "ResourceCommitment", "properties": { "acceleratorType": { -"description": "Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.", +"description": "Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR.", "type": "string" }, "amount": { -"description": "The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.", +"description": "The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. ", "format": "int64", "type": "string" }, "type": { -"description": "Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR.", +"description": "The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type.", "enum": [ "ACCELERATOR", "LOCAL_SSD", @@ -72063,7 +72279,7 @@ false "id": "RouterInterface", "properties": { "ipRange": { -"description": "IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. ", +"description": "IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. ", "type": "string" }, "ipVersion": { From 320b15d9b5ff90ee4026be711ff6ff4fd6932413 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:08 +0000 Subject: [PATCH 05/31] feat(connectors): update the api #### connectors:v1 The following keys were added: - schemas.EnrichmentConfig (Total Keys: 3) - schemas.EventingConfig.properties.enrichmentConfig.$ref (Total Keys: 1) --- ...ors_v1.projects.locations.connections.html | 15 ++++++++++++ ...cations.providers.connectors.versions.html | 1 + .../documents/connectors.v1.json | 23 ++++++++++++++++--- 3 files changed, 36 insertions(+), 3 deletions(-) diff --git a/docs/dyn/connectors_v1.projects.locations.connections.html b/docs/dyn/connectors_v1.projects.locations.connections.html index 1420ee86d4b..20c0f5ac15a 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.html @@ -379,6 +379,9 @@

Method Details

"projectId": "A String", # Optional. Project which has the topic given. "topic": "A String", # Optional. Topic to push events which couldn't be processed. }, + "enrichmentConfig": { # Data enrichment configuration. # Optional. Data enrichment configuration. + "appendAcl": True or False, # Optional. Append ACL to the event. + }, "enrichmentEnabled": True or False, # Optional. Enrichment Enabled. "eventsListenerIngressEndpoint": "A String", # Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled. "listenerAuthConfig": { # AuthConfig defines details of a authentication type. # Optional. Auth details for the event listener. @@ -907,6 +910,9 @@

Method Details

"projectId": "A String", # Optional. Project which has the topic given. "topic": "A String", # Optional. Topic to push events which couldn't be processed. }, + "enrichmentConfig": { # Data enrichment configuration. # Optional. Data enrichment configuration. + "appendAcl": True or False, # Optional. Append ACL to the event. + }, "enrichmentEnabled": True or False, # Optional. Enrichment Enabled. "eventsListenerIngressEndpoint": "A String", # Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled. "listenerAuthConfig": { # AuthConfig defines details of a authentication type. # Optional. Auth details for the event listener. @@ -1454,6 +1460,9 @@

Method Details

"projectId": "A String", # Optional. Project which has the topic given. "topic": "A String", # Optional. Topic to push events which couldn't be processed. }, + "enrichmentConfig": { # Data enrichment configuration. # Optional. Data enrichment configuration. + "appendAcl": True or False, # Optional. Append ACL to the event. + }, "enrichmentEnabled": True or False, # Optional. Enrichment Enabled. "eventsListenerIngressEndpoint": "A String", # Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled. "listenerAuthConfig": { # AuthConfig defines details of a authentication type. # Optional. Auth details for the event listener. @@ -1955,6 +1964,9 @@

Method Details

"projectId": "A String", # Optional. Project which has the topic given. "topic": "A String", # Optional. Topic to push events which couldn't be processed. }, + "enrichmentConfig": { # Data enrichment configuration. # Optional. Data enrichment configuration. + "appendAcl": True or False, # Optional. Append ACL to the event. + }, "enrichmentEnabled": True or False, # Optional. Enrichment Enabled. "eventsListenerIngressEndpoint": "A String", # Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled. "listenerAuthConfig": { # AuthConfig defines details of a authentication type. # Optional. Auth details for the event listener. @@ -2591,6 +2603,9 @@

Method Details

"projectId": "A String", # Optional. Project which has the topic given. "topic": "A String", # Optional. Topic to push events which couldn't be processed. }, + "enrichmentConfig": { # Data enrichment configuration. # Optional. Data enrichment configuration. + "appendAcl": True or False, # Optional. Append ACL to the event. + }, "enrichmentEnabled": True or False, # Optional. Enrichment Enabled. "eventsListenerIngressEndpoint": "A String", # Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled. "listenerAuthConfig": { # AuthConfig defines details of a authentication type. # Optional. Auth details for the event listener. diff --git a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html index d3de3cd61bd..8552d88fe49 100644 --- a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html +++ b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html @@ -111,6 +111,7 @@

Method Details

AUTH_SCHEMA_VIEW_UNSPECIFIED - Default value. BASIC - Basic view of the AuthSchema. JSON_SCHEMA - JSON schema view of the AuthSchema. + EUA_SCHEMA - EUA Schema view of the AuthSchema. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/googleapiclient/discovery_cache/documents/connectors.v1.json b/googleapiclient/discovery_cache/documents/connectors.v1.json index 540a96e1772..865d35455a1 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v1.json +++ b/googleapiclient/discovery_cache/documents/connectors.v1.json @@ -2370,12 +2370,14 @@ "enum": [ "AUTH_SCHEMA_VIEW_UNSPECIFIED", "BASIC", -"JSON_SCHEMA" +"JSON_SCHEMA", +"EUA_SCHEMA" ], "enumDescriptions": [ "Default value.", "Basic view of the AuthSchema.", -"JSON schema view of the AuthSchema." +"JSON schema view of the AuthSchema.", +"EUA Schema view of the AuthSchema." ], "location": "query", "type": "string" @@ -2558,7 +2560,7 @@ } } }, -"revision": "20250128", +"revision": "20250205", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -4434,6 +4436,17 @@ }, "type": "object" }, +"EnrichmentConfig": { +"description": "Data enrichment configuration.", +"id": "EnrichmentConfig", +"properties": { +"appendAcl": { +"description": "Optional. Append ACL to the event.", +"type": "boolean" +} +}, +"type": "object" +}, "EnumOption": { "description": "EnumOption definition", "id": "EnumOption", @@ -4639,6 +4652,10 @@ "$ref": "DeadLetterConfig", "description": "Optional. Dead letter configuration for eventing of a connection." }, +"enrichmentConfig": { +"$ref": "EnrichmentConfig", +"description": "Optional. Data enrichment configuration." +}, "enrichmentEnabled": { "description": "Optional. Enrichment Enabled.", "type": "boolean" From f1edd0545f3788262fabfedf0c9badc2b496ce02 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:08 +0000 Subject: [PATCH 06/31] feat(container): update the api #### container:v1 The following keys were added: - schemas.WorkloadPolicyConfig.properties.autopilotCompatibilityAuditingEnabled.type (Total Keys: 1) #### container:v1beta1 The following keys were added: - schemas.WorkloadPolicyConfig.properties.autopilotCompatibilityAuditingEnabled.type (Total Keys: 1) --- ...tainer_v1.projects.locations.clusters.html | 62 ++++++++++--------- ...projects.locations.clusters.nodePools.html | 14 ++--- .../container_v1.projects.zones.clusters.html | 58 +++++++++-------- ..._v1.projects.zones.clusters.nodePools.html | 14 ++--- ...r_v1beta1.projects.locations.clusters.html | 62 ++++++++++--------- ...projects.locations.clusters.nodePools.html | 14 ++--- ...ainer_v1beta1.projects.zones.clusters.html | 58 +++++++++-------- ...ta1.projects.zones.clusters.nodePools.html | 14 ++--- .../documents/container.v1.json | 18 +++--- .../documents/container.v1beta1.json | 18 +++--- 10 files changed, 178 insertions(+), 154 deletions(-) diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html index fd0ed41fd95..182c78c6912 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.html +++ b/docs/dyn/container_v1.projects.locations.clusters.html @@ -164,7 +164,7 @@

Method Details

{ # AutopilotCompatibilityIssue contains information about a specific compatibility issue with Autopilot mode. "constraintType": "A String", # The constraint type of the issue. "description": "A String", # The description of the issue. - "documentationUrl": "A String", # A URL to a public documnetation, which addresses resolving this issue. + "documentationUrl": "A String", # A URL to a public documentation, which addresses resolving this issue. "incompatibilityType": "A String", # The incompatibility type of this issue. "lastObservation": "A String", # The last time when this issue was observed. "subjects": [ # The name of the resources which are subject to this issue. @@ -328,6 +328,7 @@

Method Details

"enabled": True or False, # Enable Autopilot "workloadPolicyConfig": { # WorkloadPolicyConfig is the configuration related to GCW workload policy # WorkloadPolicyConfig is the configuration related to GCW workload policy "allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability. + "autopilotCompatibilityAuditingEnabled": True or False, # If true, enables the GCW Auditor that audits workloads on standard clusters. }, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. @@ -418,7 +419,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "enablePublicEndpoint": True or False, # Controls whether the control plane allows access through a public IP. It is invalid to specify both PrivateClusterConfig.enablePrivateEndpoint and this field at the same time. @@ -579,7 +580,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "meshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. @@ -625,7 +626,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. Now named inter-node transparent encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for NodePools in the cluster. }, @@ -666,7 +667,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -727,7 +728,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -852,7 +853,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -938,7 +939,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -999,7 +1000,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -1470,6 +1471,7 @@

Method Details

"enabled": True or False, # Enable Autopilot "workloadPolicyConfig": { # WorkloadPolicyConfig is the configuration related to GCW workload policy # WorkloadPolicyConfig is the configuration related to GCW workload policy "allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability. + "autopilotCompatibilityAuditingEnabled": True or False, # If true, enables the GCW Auditor that audits workloads on standard clusters. }, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. @@ -1560,7 +1562,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "enablePublicEndpoint": True or False, # Controls whether the control plane allows access through a public IP. It is invalid to specify both PrivateClusterConfig.enablePrivateEndpoint and this field at the same time. @@ -1721,7 +1723,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "meshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. @@ -1767,7 +1769,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. Now named inter-node transparent encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for NodePools in the cluster. }, @@ -1808,7 +1810,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -1869,7 +1871,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -1994,7 +1996,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -2080,7 +2082,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -2141,7 +2143,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -2415,7 +2417,7 @@

Method Details

Returns: An object of the form: - { # GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517 + { # GetJSONWebKeysResponse is a valid JSON Web Key Set as specified in rfc 7517 "cacheHeader": { # RFC-2616: cache control support # For HTTP requests, this field is automatically extracted into the Cache-Control HTTP header. "age": "A String", # 14.6 response cache age, in seconds since the response is generated "directive": "A String", # 14.9 request and response directives @@ -2515,6 +2517,7 @@

Method Details

"enabled": True or False, # Enable Autopilot "workloadPolicyConfig": { # WorkloadPolicyConfig is the configuration related to GCW workload policy # WorkloadPolicyConfig is the configuration related to GCW workload policy "allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability. + "autopilotCompatibilityAuditingEnabled": True or False, # If true, enables the GCW Auditor that audits workloads on standard clusters. }, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. @@ -2605,7 +2608,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "enablePublicEndpoint": True or False, # Controls whether the control plane allows access through a public IP. It is invalid to specify both PrivateClusterConfig.enablePrivateEndpoint and this field at the same time. @@ -2766,7 +2769,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "meshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. @@ -2812,7 +2815,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. Now named inter-node transparent encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for NodePools in the cluster. }, @@ -2853,7 +2856,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -2914,7 +2917,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -3039,7 +3042,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -3125,7 +3128,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -3186,7 +3189,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -4408,6 +4411,7 @@

Method Details

}, "desiredAutopilotWorkloadPolicyConfig": { # WorkloadPolicyConfig is the configuration related to GCW workload policy # WorkloadPolicyConfig is the configuration related to GCW workload policy "allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability. + "autopilotCompatibilityAuditingEnabled": True or False, # If true, enables the GCW Auditor that audits workloads on standard clusters. }, "desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature. "enabled": True or False, # This field is deprecated. Leave this unset and instead configure BinaryAuthorization using evaluation_mode. If evaluation_mode is set to anything other than EVALUATION_MODE_UNSPECIFIED, this field is ignored. @@ -4476,7 +4480,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -4501,7 +4505,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "enablePublicEndpoint": True or False, # Controls whether the control plane allows access through a public IP. It is invalid to specify both PrivateClusterConfig.enablePrivateEndpoint and this field at the same time. @@ -4595,7 +4599,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "desiredMasterVersion": "A String", # The Kubernetes version to change the master to. 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 default Kubernetes version diff --git a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html index cbc50e05533..72397c53e80 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html @@ -196,7 +196,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -257,7 +257,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -629,7 +629,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -690,7 +690,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -928,7 +928,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -989,7 +989,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -1525,7 +1525,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index 4e80c3cc9aa..a29bb5ea2eb 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -419,6 +419,7 @@

Method Details

"enabled": True or False, # Enable Autopilot "workloadPolicyConfig": { # WorkloadPolicyConfig is the configuration related to GCW workload policy # WorkloadPolicyConfig is the configuration related to GCW workload policy "allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability. + "autopilotCompatibilityAuditingEnabled": True or False, # If true, enables the GCW Auditor that audits workloads on standard clusters. }, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. @@ -509,7 +510,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "enablePublicEndpoint": True or False, # Controls whether the control plane allows access through a public IP. It is invalid to specify both PrivateClusterConfig.enablePrivateEndpoint and this field at the same time. @@ -670,7 +671,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "meshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. @@ -716,7 +717,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. Now named inter-node transparent encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for NodePools in the cluster. }, @@ -757,7 +758,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -818,7 +819,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -943,7 +944,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -1029,7 +1030,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -1090,7 +1091,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -1561,6 +1562,7 @@

Method Details

"enabled": True or False, # Enable Autopilot "workloadPolicyConfig": { # WorkloadPolicyConfig is the configuration related to GCW workload policy # WorkloadPolicyConfig is the configuration related to GCW workload policy "allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability. + "autopilotCompatibilityAuditingEnabled": True or False, # If true, enables the GCW Auditor that audits workloads on standard clusters. }, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. @@ -1651,7 +1653,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "enablePublicEndpoint": True or False, # Controls whether the control plane allows access through a public IP. It is invalid to specify both PrivateClusterConfig.enablePrivateEndpoint and this field at the same time. @@ -1812,7 +1814,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "meshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. @@ -1858,7 +1860,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. Now named inter-node transparent encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for NodePools in the cluster. }, @@ -1899,7 +1901,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -1960,7 +1962,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -2085,7 +2087,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -2171,7 +2173,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -2232,7 +2234,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -2650,6 +2652,7 @@

Method Details

"enabled": True or False, # Enable Autopilot "workloadPolicyConfig": { # WorkloadPolicyConfig is the configuration related to GCW workload policy # WorkloadPolicyConfig is the configuration related to GCW workload policy "allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability. + "autopilotCompatibilityAuditingEnabled": True or False, # If true, enables the GCW Auditor that audits workloads on standard clusters. }, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. @@ -2740,7 +2743,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "enablePublicEndpoint": True or False, # Controls whether the control plane allows access through a public IP. It is invalid to specify both PrivateClusterConfig.enablePrivateEndpoint and this field at the same time. @@ -2901,7 +2904,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "meshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. @@ -2947,7 +2950,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. Now named inter-node transparent encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for NodePools in the cluster. }, @@ -2988,7 +2991,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -3049,7 +3052,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -3174,7 +3177,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -3260,7 +3263,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -3321,7 +3324,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -4435,6 +4438,7 @@

Method Details

}, "desiredAutopilotWorkloadPolicyConfig": { # WorkloadPolicyConfig is the configuration related to GCW workload policy # WorkloadPolicyConfig is the configuration related to GCW workload policy "allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability. + "autopilotCompatibilityAuditingEnabled": True or False, # If true, enables the GCW Auditor that audits workloads on standard clusters. }, "desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature. "enabled": True or False, # This field is deprecated. Leave this unset and instead configure BinaryAuthorization using evaluation_mode. If evaluation_mode is set to anything other than EVALUATION_MODE_UNSPECIFIED, this field is ignored. @@ -4503,7 +4507,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -4528,7 +4532,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "enablePublicEndpoint": True or False, # Controls whether the control plane allows access through a public IP. It is invalid to specify both PrivateClusterConfig.enablePrivateEndpoint and this field at the same time. @@ -4622,7 +4626,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "desiredMasterVersion": "A String", # The Kubernetes version to change the master to. 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 default Kubernetes version diff --git a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html index 638a28f1172..0c5bfe7c25d 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html @@ -261,7 +261,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -322,7 +322,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -694,7 +694,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -755,7 +755,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -993,7 +993,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -1054,7 +1054,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -1515,7 +1515,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index 296a49ad377..dc6900922a1 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -167,7 +167,7 @@

Method Details

{ # AutopilotCompatibilityIssue contains information about a specific compatibility issue with Autopilot mode. "constraintType": "A String", # The constraint type of the issue. "description": "A String", # The description of the issue. - "documentationUrl": "A String", # A URL to a public documnetation, which addresses resolving this issue. + "documentationUrl": "A String", # A URL to a public documentation, which addresses resolving this issue. "incompatibilityType": "A String", # The incompatibility type of this issue. "lastObservation": "A String", # The last time when this issue was observed. "subjects": [ # The name of the resources which are subject to this issue. @@ -341,6 +341,7 @@

Method Details

"enabled": True or False, # Enable Autopilot "workloadPolicyConfig": { # WorkloadPolicyConfig is the configuration related to GCW workload policy # WorkloadPolicyConfig is the configuration related to GCW workload policy "allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability. + "autopilotCompatibilityAuditingEnabled": True or False, # If true, enables the GCW Auditor that audits workloads on standard clusters. }, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. @@ -441,7 +442,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "enablePublicEndpoint": True or False, # Controls whether the control plane allows access through a public IP. It is invalid to specify both PrivateClusterConfig.enablePrivateEndpoint and this field at the same time. @@ -605,7 +606,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead. @@ -655,7 +656,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -697,7 +698,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -769,7 +770,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -896,7 +897,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -991,7 +992,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -1063,7 +1064,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -1613,6 +1614,7 @@

Method Details

"enabled": True or False, # Enable Autopilot "workloadPolicyConfig": { # WorkloadPolicyConfig is the configuration related to GCW workload policy # WorkloadPolicyConfig is the configuration related to GCW workload policy "allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability. + "autopilotCompatibilityAuditingEnabled": True or False, # If true, enables the GCW Auditor that audits workloads on standard clusters. }, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. @@ -1713,7 +1715,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "enablePublicEndpoint": True or False, # Controls whether the control plane allows access through a public IP. It is invalid to specify both PrivateClusterConfig.enablePrivateEndpoint and this field at the same time. @@ -1877,7 +1879,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead. @@ -1927,7 +1929,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -1969,7 +1971,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -2041,7 +2043,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -2168,7 +2170,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -2263,7 +2265,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -2335,7 +2337,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -2640,7 +2642,7 @@

Method Details

Returns: An object of the form: - { # GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517 + { # GetJSONWebKeysResponse is a valid JSON Web Key Set as specified in rfc 7517 "cacheHeader": { # RFC-2616: cache control support # For HTTP requests, this field is automatically extracted into the Cache-Control HTTP header. "age": "A String", # 14.6 response cache age, in seconds since the response is generated "directive": "A String", # 14.9 request and response directives @@ -2750,6 +2752,7 @@

Method Details

"enabled": True or False, # Enable Autopilot "workloadPolicyConfig": { # WorkloadPolicyConfig is the configuration related to GCW workload policy # WorkloadPolicyConfig is the configuration related to GCW workload policy "allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability. + "autopilotCompatibilityAuditingEnabled": True or False, # If true, enables the GCW Auditor that audits workloads on standard clusters. }, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. @@ -2850,7 +2853,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "enablePublicEndpoint": True or False, # Controls whether the control plane allows access through a public IP. It is invalid to specify both PrivateClusterConfig.enablePrivateEndpoint and this field at the same time. @@ -3014,7 +3017,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead. @@ -3064,7 +3067,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -3106,7 +3109,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -3178,7 +3181,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -3305,7 +3308,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -3400,7 +3403,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -3472,7 +3475,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -4739,6 +4742,7 @@

Method Details

}, "desiredAutopilotWorkloadPolicyConfig": { # WorkloadPolicyConfig is the configuration related to GCW workload policy # WorkloadPolicyConfig is the configuration related to GCW workload policy "allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability. + "autopilotCompatibilityAuditingEnabled": True or False, # If true, enables the GCW Auditor that audits workloads on standard clusters. }, "desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature. "enabled": True or False, # This field is deprecated. Leave this unset and instead configure BinaryAuthorization using evaluation_mode. If evaluation_mode is set to anything other than EVALUATION_MODE_UNSPECIFIED, this field is ignored. @@ -4817,7 +4821,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -4842,7 +4846,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "enablePublicEndpoint": True or False, # Controls whether the control plane allows access through a public IP. It is invalid to specify both PrivateClusterConfig.enablePrivateEndpoint and this field at the same time. @@ -4946,7 +4950,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "desiredMasterVersion": "A String", # The Kubernetes version to change the master to. The only valid value is the latest supported version. 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 default Kubernetes version diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html index ee76dc028ed..f26bcb51486 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html @@ -200,7 +200,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -272,7 +272,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -688,7 +688,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -760,7 +760,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -1004,7 +1004,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -1076,7 +1076,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -1618,7 +1618,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index dbb79b05194..90ae3077cb8 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -439,6 +439,7 @@

Method Details

"enabled": True or False, # Enable Autopilot "workloadPolicyConfig": { # WorkloadPolicyConfig is the configuration related to GCW workload policy # WorkloadPolicyConfig is the configuration related to GCW workload policy "allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability. + "autopilotCompatibilityAuditingEnabled": True or False, # If true, enables the GCW Auditor that audits workloads on standard clusters. }, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. @@ -539,7 +540,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "enablePublicEndpoint": True or False, # Controls whether the control plane allows access through a public IP. It is invalid to specify both PrivateClusterConfig.enablePrivateEndpoint and this field at the same time. @@ -703,7 +704,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead. @@ -753,7 +754,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -795,7 +796,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -867,7 +868,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -994,7 +995,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -1089,7 +1090,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -1161,7 +1162,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -1711,6 +1712,7 @@

Method Details

"enabled": True or False, # Enable Autopilot "workloadPolicyConfig": { # WorkloadPolicyConfig is the configuration related to GCW workload policy # WorkloadPolicyConfig is the configuration related to GCW workload policy "allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability. + "autopilotCompatibilityAuditingEnabled": True or False, # If true, enables the GCW Auditor that audits workloads on standard clusters. }, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. @@ -1811,7 +1813,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "enablePublicEndpoint": True or False, # Controls whether the control plane allows access through a public IP. It is invalid to specify both PrivateClusterConfig.enablePrivateEndpoint and this field at the same time. @@ -1975,7 +1977,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead. @@ -2025,7 +2027,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -2067,7 +2069,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -2139,7 +2141,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -2266,7 +2268,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -2361,7 +2363,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -2433,7 +2435,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -2892,6 +2894,7 @@

Method Details

"enabled": True or False, # Enable Autopilot "workloadPolicyConfig": { # WorkloadPolicyConfig is the configuration related to GCW workload policy # WorkloadPolicyConfig is the configuration related to GCW workload policy "allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability. + "autopilotCompatibilityAuditingEnabled": True or False, # If true, enables the GCW Auditor that audits workloads on standard clusters. }, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. @@ -2992,7 +2995,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "enablePublicEndpoint": True or False, # Controls whether the control plane allows access through a public IP. It is invalid to specify both PrivateClusterConfig.enablePrivateEndpoint and this field at the same time. @@ -3156,7 +3159,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead. @@ -3206,7 +3209,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -3248,7 +3251,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -3320,7 +3323,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -3447,7 +3450,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -3542,7 +3545,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -3614,7 +3617,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -4766,6 +4769,7 @@

Method Details

}, "desiredAutopilotWorkloadPolicyConfig": { # WorkloadPolicyConfig is the configuration related to GCW workload policy # WorkloadPolicyConfig is the configuration related to GCW workload policy "allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability. + "autopilotCompatibilityAuditingEnabled": True or False, # If true, enables the GCW Auditor that audits workloads on standard clusters. }, "desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature. "enabled": True or False, # This field is deprecated. Leave this unset and instead configure BinaryAuthorization using evaluation_mode. If evaluation_mode is set to anything other than EVALUATION_MODE_UNSPECIFIED, this field is ignored. @@ -4844,7 +4848,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -4869,7 +4873,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "enablePublicEndpoint": True or False, # Controls whether the control plane allows access through a public IP. It is invalid to specify both PrivateClusterConfig.enablePrivateEndpoint and this field at the same time. @@ -4973,7 +4977,7 @@

Method Details

}, ], "enabled": True or False, # Whether or not master authorized networks is enabled. - "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses. + "gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessible via Google Compute Engine Public IP addresses. "privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not. }, "desiredMasterVersion": "A String", # The Kubernetes version to change the master to. The only valid value is the latest supported version. 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 default Kubernetes version diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html index 56802412416..1624c46ede0 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html @@ -265,7 +265,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -337,7 +337,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -753,7 +753,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -825,7 +825,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -1069,7 +1069,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. @@ -1141,7 +1141,7 @@

Method Details

"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. - "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. @@ -1608,7 +1608,7 @@

Method Details

"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. { # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate. - "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index 6688a847847..7622d8e4be8 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -2540,7 +2540,7 @@ } } }, -"revision": "20250114", +"revision": "20250128", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2802,7 +2802,7 @@ "type": "string" }, "documentationUrl": { -"description": "A URL to a public documnetation, which addresses resolving this issue.", +"description": "A URL to a public documentation, which addresses resolving this issue.", "type": "string" }, "incompatibilityType": { @@ -3045,7 +3045,7 @@ "id": "CertificateAuthorityDomainConfig", "properties": { "fqdns": { -"description": "List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000", +"description": "List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000", "items": { "type": "string" }, @@ -4503,7 +4503,7 @@ false "type": "object" }, "GetJSONWebKeysResponse": { -"description": "GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517", +"description": "GetJSONWebKeysResponse is a valid JSON Web Key Set as specified in rfc 7517", "id": "GetJSONWebKeysResponse", "properties": { "cacheHeader": { @@ -5213,7 +5213,7 @@ false "type": "boolean" }, "gcpPublicCidrsAccessEnabled": { -"description": "Whether master is accessbile via Google Compute Engine Public IP addresses.", +"description": "Whether master is accessible via Google Compute Engine Public IP addresses.", "type": "boolean" }, "privateEndpointEnforcementEnabled": { @@ -5409,7 +5409,7 @@ false "type": "string" }, "network": { -"description": "Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network", +"description": "Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network", "readOnly": true, "type": "string" }, @@ -5644,7 +5644,7 @@ false "type": "integer" }, "localSsdEncryptionMode": { -"description": "Specifies which method should be used for encrypting the Local SSDs attahced to the node.", +"description": "Specifies which method should be used for encrypting the Local SSDs attached to the node.", "enum": [ "LOCAL_SSD_ENCRYPTION_MODE_UNSPECIFIED", "STANDARD_ENCRYPTION", @@ -8366,6 +8366,10 @@ false "allowNetAdmin": { "description": "If true, workloads can use NET_ADMIN capability.", "type": "boolean" +}, +"autopilotCompatibilityAuditingEnabled": { +"description": "If true, enables the GCW Auditor that audits workloads on standard clusters.", +"type": "boolean" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index 351cf37ef33..f367cd793ce 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -2685,7 +2685,7 @@ } } }, -"revision": "20250114", +"revision": "20250128", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2989,7 +2989,7 @@ "type": "string" }, "documentationUrl": { -"description": "A URL to a public documnetation, which addresses resolving this issue.", +"description": "A URL to a public documentation, which addresses resolving this issue.", "type": "string" }, "incompatibilityType": { @@ -3291,7 +3291,7 @@ "id": "CertificateAuthorityDomainConfig", "properties": { "fqdns": { -"description": "List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000", +"description": "List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000", "items": { "type": "string" }, @@ -4965,7 +4965,7 @@ false "type": "object" }, "GetJSONWebKeysResponse": { -"description": "GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517", +"description": "GetJSONWebKeysResponse is a valid JSON Web Key Set as specified in rfc 7517", "id": "GetJSONWebKeysResponse", "properties": { "cacheHeader": { @@ -5798,7 +5798,7 @@ false "type": "boolean" }, "gcpPublicCidrsAccessEnabled": { -"description": "Whether master is accessbile via Google Compute Engine Public IP addresses.", +"description": "Whether master is accessible via Google Compute Engine Public IP addresses.", "type": "boolean" }, "privateEndpointEnforcementEnabled": { @@ -6013,7 +6013,7 @@ false "type": "string" }, "network": { -"description": "Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network", +"description": "Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network", "readOnly": true, "type": "string" }, @@ -6268,7 +6268,7 @@ false "type": "integer" }, "localSsdEncryptionMode": { -"description": "Specifies which method should be used for encrypting the Local SSDs attahced to the node.", +"description": "Specifies which method should be used for encrypting the Local SSDs attached to the node.", "enum": [ "LOCAL_SSD_ENCRYPTION_MODE_UNSPECIFIED", "STANDARD_ENCRYPTION", @@ -9354,6 +9354,10 @@ true "allowNetAdmin": { "description": "If true, workloads can use NET_ADMIN capability.", "type": "boolean" +}, +"autopilotCompatibilityAuditingEnabled": { +"description": "If true, enables the GCW Auditor that audits workloads on standard clusters.", +"type": "boolean" } }, "type": "object" From a736a5d757b3e03891c6f0bc3050e64864fb2afe Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:08 +0000 Subject: [PATCH 07/31] feat(content): update the api #### content:v2.1 The following keys were added: - schemas.AccountIssue.properties.prerenderedOutOfCourtDisputeSettlement.type (Total Keys: 1) - schemas.ProductIssue.properties.prerenderedOutOfCourtDisputeSettlement.type (Total Keys: 1) - schemas.RenderAccountIssuesResponse.properties.alternateDisputeResolution.deprecated (Total Keys: 1) - schemas.RenderProductIssuesResponse.properties.alternateDisputeResolution.deprecated (Total Keys: 1) --- docs/dyn/content_v2_1.merchantsupport.html | 6 ++++-- .../discovery_cache/documents/content.v2.1.json | 16 +++++++++++++--- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/docs/dyn/content_v2_1.merchantsupport.html b/docs/dyn/content_v2_1.merchantsupport.html index 44fe500d285..34360b91878 100644 --- a/docs/dyn/content_v2_1.merchantsupport.html +++ b/docs/dyn/content_v2_1.merchantsupport.html @@ -117,7 +117,7 @@

Method Details

An object of the form: { # Response containing support content and actions for listed account issues. - "alternateDisputeResolution": { # The Alternate Dispute Resolution (ADR) that may be available to merchants in some regions. If present, the link should be shown on the same page as the list of issues. # The Alternate Dispute Resolution (ADR) contains a link to a page where merchant can bring their appeal to an [external body](https://support.google.com/european-union-digital-services-act-redress-options/answer/13535501). If the ADR is present, it MUST be available to the merchant on the page that shows the list with their account issues. + "alternateDisputeResolution": { # The Alternate Dispute Resolution (ADR) that may be available to merchants in some regions. If present, the link should be shown on the same page as the list of issues. # Alternate Dispute Resolution (ADR) is deprecated. Use `prerendered_out_of_court_dispute_settlement` instead. "label": "A String", # The label for the alternate dispute resolution link. "uri": "A String", # The URL pointing to a page, where merchant can request alternative dispute resolution with an [external body](https://support.google.com/european-union-digital-services-act-redress-options/answer/13535501). }, @@ -228,6 +228,7 @@

Method Details

"severity": "A String", # The severity of the issue. }, "prerenderedContent": "A String", # Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class. + "prerenderedOutOfCourtDisputeSettlement": "A String", # Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `ods-section`* - wrapper around the out-of-court dispute resolution section * `ods-description`* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link. * `ods-param`* - wrapper around the header-value pair for parameters that merchant may need to provide during the ODS process. * `ods-routing-id`* - ods param for the Routing ID. * `ods-reference-id`* - ods param for the Routing ID. * `ods-param-header`* - header for the ODS parameter * `ods-param-value`* - value of the ODS parameter. This value should be rendered in a way that it is easy for merchants to identify and copy. * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. "title": "A String", # Title of the issue. }, ], @@ -260,7 +261,7 @@

Method Details

An object of the form: { # Response containing support content and actions for listed product issues. - "alternateDisputeResolution": { # The Alternate Dispute Resolution (ADR) that may be available to merchants in some regions. If present, the link should be shown on the same page as the list of issues. # The Alternate Dispute Resolution (ADR) contains a link to a page where merchant can bring their appeal to an [external body](https://support.google.com/european-union-digital-services-act-redress-options/answer/13535501). If present, the link should be shown on the same page as the list of issues. + "alternateDisputeResolution": { # The Alternate Dispute Resolution (ADR) that may be available to merchants in some regions. If present, the link should be shown on the same page as the list of issues. # Alternate Dispute Resolution (ADR) is deprecated. Use `prerendered_out_of_court_dispute_settlement` instead. "label": "A String", # The label for the alternate dispute resolution link. "uri": "A String", # The URL pointing to a page, where merchant can request alternative dispute resolution with an [external body](https://support.google.com/european-union-digital-services-act-redress-options/answer/13535501). }, @@ -371,6 +372,7 @@

Method Details

"severity": "A String", # The severity of the issue. }, "prerenderedContent": "A String", # Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `list-intro` - marks the paragraph that contains an intro for a list. This paragraph will be always followed by a list. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class. + "prerenderedOutOfCourtDisputeSettlement": "A String", # Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `ods-section`* - wrapper around the out-of-court dispute resolution section * `ods-description`* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link. * `ods-param`* - wrapper around the header-value pair for parameters that merchant may need to provide during the ODS process. * `ods-routing-id`* - ods param for the Routing ID. * `ods-reference-id`* - ods param for the Routing ID. * `ods-param-header`* - header for the ODS parameter * `ods-param-value`* - value of the ODS parameter. This value should be rendered in a way that it is easy for merchants to identify and copy. * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. "title": "A String", # Title of the issue. }, ], diff --git a/googleapiclient/discovery_cache/documents/content.v2.1.json b/googleapiclient/discovery_cache/documents/content.v2.1.json index 2da2ed1d869..d2c954b9b8e 100644 --- a/googleapiclient/discovery_cache/documents/content.v2.1.json +++ b/googleapiclient/discovery_cache/documents/content.v2.1.json @@ -4570,7 +4570,7 @@ } } }, -"revision": "20250115", +"revision": "20250208", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { @@ -4944,6 +4944,10 @@ false "description": "Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class.", "type": "string" }, +"prerenderedOutOfCourtDisputeSettlement": { +"description": "Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `ods-section`* - wrapper around the out-of-court dispute resolution section * `ods-description`* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link. * `ods-param`* - wrapper around the header-value pair for parameters that merchant may need to provide during the ODS process. * `ods-routing-id`* - ods param for the Routing ID. * `ods-reference-id`* - ods param for the Routing ID. * `ods-param-header`* - header for the ODS parameter * `ods-param-value`* - value of the ODS parameter. This value should be rendered in a way that it is easy for merchants to identify and copy. * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon.", +"type": "string" +}, "title": { "description": "Title of the issue.", "type": "string" @@ -10758,6 +10762,10 @@ false "description": "Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `list-intro` - marks the paragraph that contains an intro for a list. This paragraph will be always followed by a list. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class.", "type": "string" }, +"prerenderedOutOfCourtDisputeSettlement": { +"description": "Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `ods-section`* - wrapper around the out-of-court dispute resolution section * `ods-description`* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link. * `ods-param`* - wrapper around the header-value pair for parameters that merchant may need to provide during the ODS process. * `ods-routing-id`* - ods param for the Routing ID. * `ods-reference-id`* - ods param for the Routing ID. * `ods-param-header`* - header for the ODS parameter * `ods-param-value`* - value of the ODS parameter. This value should be rendered in a way that it is easy for merchants to identify and copy. * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon.", +"type": "string" +}, "title": { "description": "Title of the issue.", "type": "string" @@ -12492,7 +12500,8 @@ false "properties": { "alternateDisputeResolution": { "$ref": "AlternateDisputeResolution", -"description": "The Alternate Dispute Resolution (ADR) contains a link to a page where merchant can bring their appeal to an [external body](https://support.google.com/european-union-digital-services-act-redress-options/answer/13535501). If the ADR is present, it MUST be available to the merchant on the page that shows the list with their account issues." +"deprecated": true, +"description": "Alternate Dispute Resolution (ADR) is deprecated. Use `prerendered_out_of_court_dispute_settlement` instead." }, "issues": { "description": "List of account issues for a given account. This list can be shown with compressed, expandable items. In the compressed form, the title and impact should be shown for each issue. Once the issue is expanded, the detailed content and available actions should be rendered.", @@ -12543,7 +12552,8 @@ false "properties": { "alternateDisputeResolution": { "$ref": "AlternateDisputeResolution", -"description": "The Alternate Dispute Resolution (ADR) contains a link to a page where merchant can bring their appeal to an [external body](https://support.google.com/european-union-digital-services-act-redress-options/answer/13535501). If present, the link should be shown on the same page as the list of issues." +"deprecated": true, +"description": "Alternate Dispute Resolution (ADR) is deprecated. Use `prerendered_out_of_court_dispute_settlement` instead." }, "issues": { "description": "List of issues for a given product. This list can be shown with compressed, expandable items. In the compressed form, the title and impact should be shown for each issue. Once the issue is expanded, the detailed content and available actions should be rendered.", From 8f2146728eef6499ace11722a1a2381853526cbc Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:08 +0000 Subject: [PATCH 08/31] feat(dataflow): update the api #### dataflow:v1b3 The following keys were added: - schemas.TemplateMetadata.properties.yamlDefinition.type (Total Keys: 1) --- ...taflow_v1b3.projects.locations.flexTemplates.html | 1 + .../dataflow_v1b3.projects.locations.templates.html | 1 + docs/dyn/dataflow_v1b3.projects.templates.html | 1 + .../discovery_cache/documents/dataflow.v1b3.json | 12 +++++++++--- 4 files changed, 12 insertions(+), 3 deletions(-) diff --git a/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html b/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html index 30ebbf1cb0f..c854d3136ee 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html @@ -170,6 +170,7 @@

Method Details

"streaming": True or False, # Optional. Indicates if the template is streaming or not. "supportsAtLeastOnce": True or False, # Optional. Indicates if the streaming template supports at least once mode. "supportsExactlyOnce": True or False, # Optional. Indicates if the streaming template supports exactly once mode. + "yamlDefinition": "A String", # Optional. For future use. }, "sdkInfo": { # SDK Information. # Required. SDK info of the Flex Template. "language": "A String", # Required. The SDK Language. diff --git a/docs/dyn/dataflow_v1b3.projects.locations.templates.html b/docs/dyn/dataflow_v1b3.projects.locations.templates.html index cdf5a18aaec..0c7a736d475 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.templates.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.templates.html @@ -529,6 +529,7 @@

Method Details

"streaming": True or False, # Optional. Indicates if the template is streaming or not. "supportsAtLeastOnce": True or False, # Optional. Indicates if the streaming template supports at least once mode. "supportsExactlyOnce": True or False, # Optional. Indicates if the streaming template supports exactly once mode. + "yamlDefinition": "A String", # Optional. For future use. }, "runtimeMetadata": { # RuntimeMetadata describing a runtime environment. # Describes the runtime metadata with SDKInfo and available parameters. "parameters": [ # The parameters for the template. diff --git a/docs/dyn/dataflow_v1b3.projects.templates.html b/docs/dyn/dataflow_v1b3.projects.templates.html index 8ed02245214..46ea134a4a3 100644 --- a/docs/dyn/dataflow_v1b3.projects.templates.html +++ b/docs/dyn/dataflow_v1b3.projects.templates.html @@ -528,6 +528,7 @@

Method Details

"streaming": True or False, # Optional. Indicates if the template is streaming or not. "supportsAtLeastOnce": True or False, # Optional. Indicates if the streaming template supports at least once mode. "supportsExactlyOnce": True or False, # Optional. Indicates if the streaming template supports exactly once mode. + "yamlDefinition": "A String", # Optional. For future use. }, "runtimeMetadata": { # RuntimeMetadata describing a runtime environment. # Describes the runtime metadata with SDKInfo and available parameters. "parameters": [ # The parameters for the template. diff --git a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json index e3b8e32cc38..1bc653db71b 100644 --- a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json +++ b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json @@ -2208,7 +2208,7 @@ } } }, -"revision": "20250106", +"revision": "20250131", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -5747,13 +5747,15 @@ false "UNKNOWN", "JAVA", "PYTHON", -"GO" +"GO", +"YAML" ], "enumDescriptions": [ "UNKNOWN Language.", "Java.", "Python.", -"Go." +"Go.", +"YAML." ], "type": "string" }, @@ -7241,6 +7243,10 @@ false "supportsExactlyOnce": { "description": "Optional. Indicates if the streaming template supports exactly once mode.", "type": "boolean" +}, +"yamlDefinition": { +"description": "Optional. For future use.", +"type": "string" } }, "type": "object" From e7d1b244fb6c03d3a48d1f4531f4c79ca98fbb73 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:09 +0000 Subject: [PATCH 09/31] feat(dataform): update the api #### dataform:v1beta1 The following keys were added: - schemas.ScheduledExecutionRecord.properties.executionTime.readOnly (Total Keys: 1) - schemas.ScheduledReleaseRecord.properties.releaseTime.readOnly (Total Keys: 1) - schemas.UncommittedFileChange.properties.state.readOnly (Total Keys: 1) --- ...tions.repositories.compilationResults.html | 84 +++++++++---------- ...beta1.projects.locations.repositories.html | 16 ++-- ...locations.repositories.releaseConfigs.html | 24 +++--- ...ocations.repositories.workflowConfigs.html | 48 +++++------ ...ions.repositories.workflowInvocations.html | 44 +++++----- ...cts.locations.repositories.workspaces.html | 10 +-- .../documents/dataform.v1beta1.json | 28 ++++--- 7 files changed, 130 insertions(+), 124 deletions(-) diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.compilationResults.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.compilationResults.html index 8af9e446473..61d759a2644 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.compilationResults.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.compilationResults.html @@ -116,7 +116,7 @@

Method Details

"databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names. "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID). "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations. - "defaultNotebookRuntimeOptions": { + "defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options. "gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`. }, "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID). @@ -129,9 +129,9 @@

Method Details

"compilationErrors": [ # Output only. Errors encountered during project compilation. { # An error encountered when attempting to compile a Dataform project. "actionTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The identifier of the action where this error occurred, if available. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, "message": "A String", # Output only. The error's top level message. "path": "A String", # Output only. The path of the file where this error occurred, if available, relative to the project root. @@ -140,7 +140,7 @@

Method Details

], "createTime": "A String", # Output only. The timestamp of when the compilation result was created. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key. - "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. + "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "dataformCoreVersion": "A String", # Output only. The version of `@dataform/core` that was used for compilation. "gitCommitish": "A String", # Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1` @@ -165,7 +165,7 @@

Method Details

"databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names. "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID). "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations. - "defaultNotebookRuntimeOptions": { + "defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options. "gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`. }, "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID). @@ -178,9 +178,9 @@

Method Details

"compilationErrors": [ # Output only. Errors encountered during project compilation. { # An error encountered when attempting to compile a Dataform project. "actionTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The identifier of the action where this error occurred, if available. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, "message": "A String", # Output only. The error's top level message. "path": "A String", # Output only. The path of the file where this error occurred, if available, relative to the project root. @@ -189,7 +189,7 @@

Method Details

], "createTime": "A String", # Output only. The timestamp of when the compilation result was created. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key. - "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. + "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "dataformCoreVersion": "A String", # Output only. The version of `@dataform/core` that was used for compilation. "gitCommitish": "A String", # Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1` @@ -221,7 +221,7 @@

Method Details

"databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names. "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID). "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations. - "defaultNotebookRuntimeOptions": { + "defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options. "gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`. }, "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID). @@ -234,9 +234,9 @@

Method Details

"compilationErrors": [ # Output only. Errors encountered during project compilation. { # An error encountered when attempting to compile a Dataform project. "actionTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The identifier of the action where this error occurred, if available. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, "message": "A String", # Output only. The error's top level message. "path": "A String", # Output only. The path of the file where this error occurred, if available, relative to the project root. @@ -245,7 +245,7 @@

Method Details

], "createTime": "A String", # Output only. The timestamp of when the compilation result was created. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key. - "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. + "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "dataformCoreVersion": "A String", # Output only. The version of `@dataform/core` that was used for compilation. "gitCommitish": "A String", # Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1` @@ -283,7 +283,7 @@

Method Details

"databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names. "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID). "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations. - "defaultNotebookRuntimeOptions": { + "defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options. "gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`. }, "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID). @@ -296,9 +296,9 @@

Method Details

"compilationErrors": [ # Output only. Errors encountered during project compilation. { # An error encountered when attempting to compile a Dataform project. "actionTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The identifier of the action where this error occurred, if available. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, "message": "A String", # Output only. The error's top level message. "path": "A String", # Output only. The path of the file where this error occurred, if available, relative to the project root. @@ -307,7 +307,7 @@

Method Details

], "createTime": "A String", # Output only. The timestamp of when the compilation result was created. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key. - "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. + "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "dataformCoreVersion": "A String", # Output only. The version of `@dataform/core` that was used for compilation. "gitCommitish": "A String", # Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1` @@ -362,16 +362,16 @@

Method Details

"assertion": { # Represents an assertion upon a SQL query which is required return zero rows. # The assertion executed by this action. "dependencyTargets": [ # A list of actions that this action depends on. { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, ], "disabled": True or False, # Whether this action is disabled (i.e. should not be run). "parentAction": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # The parent action of this assertion. Only set if this assertion was automatically generated. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, "relationDescriptor": { # Describes a relation and its columns. # Descriptor for the assertion's automatically-generated view and its columns. "bigqueryLabels": { # A set of BigQuery labels that should be applied to the relation. @@ -396,9 +396,9 @@

Method Details

], }, "canonicalTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, "declaration": { # Represents a relation which is not managed by Dataform but which may be referenced by Dataform actions. # The declaration declared by this action. "relationDescriptor": { # Describes a relation and its columns. # Descriptor for the relation and its columns. Used as documentation only, i.e. values here will result in no changes to the relation's metadata. @@ -421,13 +421,13 @@

Method Details

}, "filePath": "A String", # The full path including filename in which this action is located, relative to the workspace root. "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. - "notebook": { # The notebook executed by this action. + "notebook": { # Represents a notebook. # The notebook executed by this action. "contents": "A String", # The contents of the notebook. "dependencyTargets": [ # A list of actions that this action depends on. { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, ], "disabled": True or False, # Whether this action is disabled (i.e. should not be run). @@ -438,9 +438,9 @@

Method Details

"operations": { # Represents a list of arbitrary database operations. # The database operations executed by this action. "dependencyTargets": [ # A list of actions that this action depends on. { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, ], "disabled": True or False, # Whether this action is disabled (i.e. should not be run). @@ -478,9 +478,9 @@

Method Details

], "dependencyTargets": [ # A list of actions that this action depends on. { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, ], "disabled": True or False, # Whether this action is disabled (i.e. should not be run). @@ -531,9 +531,9 @@

Method Details

], }, "target": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # This action's identifier. Unique within the compilation result. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, }, ], diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.html index bcb9b38c750..a9f5189acb8 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.html @@ -176,7 +176,7 @@

Method Details

}, "commitMessage": "A String", # Optional. The commit's message. }, - "fileOperations": { # A map to the path of the file to the operation. The path is the full file path including filename, from repository root. + "fileOperations": { # Optional. A map to the path of the file to the operation. The path is the full file path including filename, from repository root. "a_key": { # Represents a single file operation to the repository. "deleteFile": { # Represents the delete file operation. # Represents the delete operation. }, @@ -232,7 +232,7 @@

Method Details

{ # Represents a Dataform Git repository. "createTime": "A String", # Output only. The timestamp of when the repository was created. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key. - "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. + "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. @@ -273,7 +273,7 @@

Method Details

{ # Represents a Dataform Git repository. "createTime": "A String", # Output only. The timestamp of when the repository was created. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key. - "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. + "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. @@ -309,7 +309,7 @@

Method Details

Args: name: string, Required. The repository's name. (required) - force: boolean, If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.) + force: boolean, Optional. If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -406,7 +406,7 @@

Method Details

{ # Represents a Dataform Git repository. "createTime": "A String", # Output only. The timestamp of when the repository was created. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key. - "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. + "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. @@ -495,7 +495,7 @@

Method Details

{ # Represents a Dataform Git repository. "createTime": "A String", # Output only. The timestamp of when the repository was created. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key. - "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. + "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. @@ -556,7 +556,7 @@

Method Details

{ # Represents a Dataform Git repository. "createTime": "A String", # Output only. The timestamp of when the repository was created. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key. - "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. + "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. @@ -597,7 +597,7 @@

Method Details

{ # Represents a Dataform Git repository. "createTime": "A String", # Output only. The timestamp of when the repository was created. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key. - "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. + "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.releaseConfigs.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.releaseConfigs.html index 39ac79d7111..0cca04f4ebe 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.releaseConfigs.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.releaseConfigs.html @@ -116,7 +116,7 @@

Method Details

"databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names. "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID). "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations. - "defaultNotebookRuntimeOptions": { + "defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options. "gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`. }, "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID). @@ -143,7 +143,7 @@

Method Details

], "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. }, - "releaseTime": "A String", # The timestamp of this release attempt. + "releaseTime": "A String", # Output only. The timestamp of this release attempt. }, ], "releaseCompilationResult": "A String", # Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. @@ -165,7 +165,7 @@

Method Details

"databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names. "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID). "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations. - "defaultNotebookRuntimeOptions": { + "defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options. "gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`. }, "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID). @@ -192,7 +192,7 @@

Method Details

], "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. }, - "releaseTime": "A String", # The timestamp of this release attempt. + "releaseTime": "A String", # Output only. The timestamp of this release attempt. }, ], "releaseCompilationResult": "A String", # Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. @@ -238,7 +238,7 @@

Method Details

"databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names. "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID). "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations. - "defaultNotebookRuntimeOptions": { + "defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options. "gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`. }, "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID). @@ -265,7 +265,7 @@

Method Details

], "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. }, - "releaseTime": "A String", # The timestamp of this release attempt. + "releaseTime": "A String", # Output only. The timestamp of this release attempt. }, ], "releaseCompilationResult": "A String", # Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. @@ -298,7 +298,7 @@

Method Details

"databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names. "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID). "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations. - "defaultNotebookRuntimeOptions": { + "defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options. "gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`. }, "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID). @@ -325,7 +325,7 @@

Method Details

], "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. }, - "releaseTime": "A String", # The timestamp of this release attempt. + "releaseTime": "A String", # Output only. The timestamp of this release attempt. }, ], "releaseCompilationResult": "A String", # Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. @@ -367,7 +367,7 @@

Method Details

"databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names. "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID). "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations. - "defaultNotebookRuntimeOptions": { + "defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options. "gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`. }, "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID). @@ -394,7 +394,7 @@

Method Details

], "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. }, - "releaseTime": "A String", # The timestamp of this release attempt. + "releaseTime": "A String", # Output only. The timestamp of this release attempt. }, ], "releaseCompilationResult": "A String", # Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. @@ -416,7 +416,7 @@

Method Details

"databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names. "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID). "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations. - "defaultNotebookRuntimeOptions": { + "defaultNotebookRuntimeOptions": { # Configures various aspects of Dataform notebook runtime. # Optional. The default notebook runtime options. "gcsOutputBucket": "A String", # Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`. }, "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID). @@ -443,7 +443,7 @@

Method Details

], "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. }, - "releaseTime": "A String", # The timestamp of this release attempt. + "releaseTime": "A String", # Output only. The timestamp of this release attempt. }, ], "releaseCompilationResult": "A String", # Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowConfigs.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowConfigs.html index bfe6749ee6a..09eabefc608 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowConfigs.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowConfigs.html @@ -121,9 +121,9 @@

Method Details

], "includedTargets": [ # Optional. The set of action identifiers to include. { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, ], "serviceAccount": "A String", # Optional. The service account to run workflow invocations under. @@ -142,7 +142,7 @@

Method Details

], "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. }, - "executionTime": "A String", # The timestamp of this execution attempt. + "executionTime": "A String", # Output only. The timestamp of this execution attempt. "workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`. }, ], @@ -171,9 +171,9 @@

Method Details

], "includedTargets": [ # Optional. The set of action identifiers to include. { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, ], "serviceAccount": "A String", # Optional. The service account to run workflow invocations under. @@ -192,7 +192,7 @@

Method Details

], "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. }, - "executionTime": "A String", # The timestamp of this execution attempt. + "executionTime": "A String", # Output only. The timestamp of this execution attempt. "workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`. }, ], @@ -245,9 +245,9 @@

Method Details

], "includedTargets": [ # Optional. The set of action identifiers to include. { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, ], "serviceAccount": "A String", # Optional. The service account to run workflow invocations under. @@ -266,7 +266,7 @@

Method Details

], "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. }, - "executionTime": "A String", # The timestamp of this execution attempt. + "executionTime": "A String", # Output only. The timestamp of this execution attempt. "workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`. }, ], @@ -309,9 +309,9 @@

Method Details

], "includedTargets": [ # Optional. The set of action identifiers to include. { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, ], "serviceAccount": "A String", # Optional. The service account to run workflow invocations under. @@ -330,7 +330,7 @@

Method Details

], "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. }, - "executionTime": "A String", # The timestamp of this execution attempt. + "executionTime": "A String", # Output only. The timestamp of this execution attempt. "workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`. }, ], @@ -376,9 +376,9 @@

Method Details

], "includedTargets": [ # Optional. The set of action identifiers to include. { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, ], "serviceAccount": "A String", # Optional. The service account to run workflow invocations under. @@ -397,7 +397,7 @@

Method Details

], "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. }, - "executionTime": "A String", # The timestamp of this execution attempt. + "executionTime": "A String", # Output only. The timestamp of this execution attempt. "workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`. }, ], @@ -426,9 +426,9 @@

Method Details

], "includedTargets": [ # Optional. The set of action identifiers to include. { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, ], "serviceAccount": "A String", # Optional. The service account to run workflow invocations under. @@ -447,7 +447,7 @@

Method Details

], "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. }, - "executionTime": "A String", # The timestamp of this execution attempt. + "executionTime": "A String", # Output only. The timestamp of this execution attempt. "workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`. }, ], diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowInvocations.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowInvocations.html index 9fa524bd6bb..aa33b13cf5f 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowInvocations.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowInvocations.html @@ -143,7 +143,7 @@

Method Details

{ # Represents a single invocation of a compilation result. "compilationResult": "A String", # Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key. - "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. + "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used. @@ -153,9 +153,9 @@

Method Details

], "includedTargets": [ # Optional. The set of action identifiers to include. { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, ], "serviceAccount": "A String", # Optional. The service account to run workflow invocations under. @@ -183,7 +183,7 @@

Method Details

{ # Represents a single invocation of a compilation result. "compilationResult": "A String", # Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key. - "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. + "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used. @@ -193,9 +193,9 @@

Method Details

], "includedTargets": [ # Optional. The set of action identifiers to include. { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, ], "serviceAccount": "A String", # Optional. The service account to run workflow invocations under. @@ -248,7 +248,7 @@

Method Details

{ # Represents a single invocation of a compilation result. "compilationResult": "A String", # Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key. - "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. + "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used. @@ -258,9 +258,9 @@

Method Details

], "includedTargets": [ # Optional. The set of action identifiers to include. { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, ], "serviceAccount": "A String", # Optional. The service account to run workflow invocations under. @@ -305,7 +305,7 @@

Method Details

{ # Represents a single invocation of a compilation result. "compilationResult": "A String", # Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key. - "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. + "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used. @@ -315,9 +315,9 @@

Method Details

], "includedTargets": [ # Optional. The set of action identifiers to include. { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, ], "serviceAccount": "A String", # Optional. The service account to run workflow invocations under. @@ -376,9 +376,9 @@

Method Details

"sqlScript": "A String", # Output only. The generated BigQuery SQL script that will be executed. }, "canonicalTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, "failureReason": "A String", # Output only. If and only if action's state is FAILED a failure reason is set. "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. @@ -392,9 +392,9 @@

Method Details

}, "state": "A String", # Output only. This action's current state. "target": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. This action's identifier. Unique within the workflow invocation. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. }, }, ], diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html index 60e1ca04062..ce820a678ab 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html @@ -208,7 +208,7 @@

Method Details

{ # Represents a Dataform Git workspace. "createTime": "A String", # Output only. The timestamp of when the workspace was created. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key. - "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. + "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "name": "A String", # Identifier. The workspace's name. @@ -226,7 +226,7 @@

Method Details

{ # Represents a Dataform Git workspace. "createTime": "A String", # Output only. The timestamp of when the workspace was created. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key. - "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. + "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "name": "A String", # Identifier. The workspace's name. @@ -289,7 +289,7 @@

Method Details

"uncommittedFileChanges": [ # A list of all files which have uncommitted Git changes. There will only be a single entry for any given file. { # Represents the Git state of a file with uncommitted changes. "path": "A String", # The file's full path including filename, relative to the workspace root. - "state": "A String", # Indicates the status of the file. + "state": "A String", # Output only. Indicates the status of the file. }, ], }
@@ -333,7 +333,7 @@

Method Details

{ # Represents a Dataform Git workspace. "createTime": "A String", # Output only. The timestamp of when the workspace was created. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key. - "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. + "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "name": "A String", # Identifier. The workspace's name. @@ -426,7 +426,7 @@

Method Details

{ # Represents a Dataform Git workspace. "createTime": "A String", # Output only. The timestamp of when the workspace was created. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key. - "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. + "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "name": "A String", # Identifier. The workspace's name. diff --git a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json index d587f92ad2d..ac151250b2a 100644 --- a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json @@ -333,7 +333,7 @@ ], "parameters": { "force": { -"description": "If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.)", +"description": "Optional. If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.)", "location": "query", "type": "boolean" }, @@ -2076,7 +2076,7 @@ } } }, -"revision": "20250119", +"revision": "20250202", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "Assertion": { @@ -2182,7 +2182,8 @@ "type": "string" }, "defaultNotebookRuntimeOptions": { -"$ref": "NotebookRuntimeOptions" +"$ref": "NotebookRuntimeOptions", +"description": "Optional. The default notebook runtime options." }, "defaultSchema": { "description": "Optional. The default schema (BigQuery dataset ID).", @@ -2297,7 +2298,7 @@ "additionalProperties": { "$ref": "FileOperation" }, -"description": "A map to the path of the file to the operation. The path is the full file path including filename, from repository root.", +"description": "Optional. A map to the path of the file to the operation. The path is the full file path including filename, from repository root.", "type": "object" }, "requiredHeadCommitSha": { @@ -2516,7 +2517,7 @@ "id": "DataEncryptionState", "properties": { "kmsKeyVersionName": { -"description": "The KMS key version name with which data of a resource is encrypted.", +"description": "Required. The KMS key version name with which data of a resource is encrypted.", "type": "string" } }, @@ -3103,6 +3104,7 @@ "type": "object" }, "Notebook": { +"description": "Represents a notebook.", "id": "Notebook", "properties": { "contents": { @@ -3148,6 +3150,7 @@ "type": "object" }, "NotebookRuntimeOptions": { +"description": "Configures various aspects of Dataform notebook runtime.", "id": "NotebookRuntimeOptions", "properties": { "gcsOutputBucket": { @@ -3667,8 +3670,9 @@ "description": "The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful." }, "executionTime": { -"description": "The timestamp of this execution attempt.", +"description": "Output only. The timestamp of this execution attempt.", "format": "google-datetime", +"readOnly": true, "type": "string" }, "workflowInvocation": { @@ -3691,8 +3695,9 @@ "description": "The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful." }, "releaseTime": { -"description": "The timestamp of this release attempt.", +"description": "Output only. The timestamp of this release attempt.", "format": "google-datetime", +"readOnly": true, "type": "string" } }, @@ -3789,15 +3794,15 @@ "id": "Target", "properties": { "database": { -"description": "The action's database (Google Cloud project ID) .", +"description": "Optional. The action's database (Google Cloud project ID) .", "type": "string" }, "name": { -"description": "The action's name, within `database` and `schema`.", +"description": "Optional. The action's name, within `database` and `schema`.", "type": "string" }, "schema": { -"description": "The action's schema (BigQuery dataset ID), within `database`.", +"description": "Optional. The action's schema (BigQuery dataset ID), within `database`.", "type": "string" } }, @@ -3840,7 +3845,7 @@ "type": "string" }, "state": { -"description": "Indicates the status of the file.", +"description": "Output only. Indicates the status of the file.", "enum": [ "STATE_UNSPECIFIED", "ADDED", @@ -3855,6 +3860,7 @@ "The file has been modified.", "The file contains merge conflicts." ], +"readOnly": true, "type": "string" } }, From e3d6ecf8d9419ac00827fe73ba7510cfbc6954fe Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:09 +0000 Subject: [PATCH 10/31] fix(datalineage): update the api #### datalineage:v1 The following keys were changed: - endpoints (Total Keys: 1) --- .../discovery_cache/documents/datalineage.v1.json | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/googleapiclient/discovery_cache/documents/datalineage.v1.json b/googleapiclient/discovery_cache/documents/datalineage.v1.json index 4880c90eafd..401a15935d1 100644 --- a/googleapiclient/discovery_cache/documents/datalineage.v1.json +++ b/googleapiclient/discovery_cache/documents/datalineage.v1.json @@ -113,6 +113,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://datalineage.europe-west15.rep.googleapis.com/", +"location": "europe-west15" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://datalineage.europe-west2.rep.googleapis.com/", "location": "europe-west2" }, @@ -1035,7 +1040,7 @@ } } }, -"revision": "20241202", +"revision": "20250131", "rootUrl": "https://datalineage.googleapis.com/", "schemas": { "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest": { From e08d784dd5858538ff163a3c8add1812b8c98687 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:09 +0000 Subject: [PATCH 11/31] feat(dataproc): update the api #### dataproc:v1 The following keys were added: - schemas.GceClusterConfig.properties.resourceManagerTags (Total Keys: 2) --- ....projects.locations.workflowTemplates.html | 21 +++++++++++++++++++ ...dataproc_v1.projects.regions.clusters.html | 12 +++++++++++ ...v1.projects.regions.workflowTemplates.html | 21 +++++++++++++++++++ .../documents/dataproc.v1.json | 9 +++++++- 4 files changed, 62 insertions(+), 1 deletion(-) diff --git a/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html b/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html index 8eaf571ae1b..11cd9e76197 100644 --- a/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html +++ b/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html @@ -520,6 +520,9 @@

Method Details

"A String", ], }, + "resourceManagerTags": { # Optional. Resource manager tags to add to all instances (see Resource manager tags resources (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)). + "a_key": "A String", + }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control "A String", @@ -1222,6 +1225,9 @@

Method Details

"A String", ], }, + "resourceManagerTags": { # Optional. Resource manager tags to add to all instances (see Resource manager tags resources (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)). + "a_key": "A String", + }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control "A String", @@ -1951,6 +1957,9 @@

Method Details

"A String", ], }, + "resourceManagerTags": { # Optional. Resource manager tags to add to all instances (see Resource manager tags resources (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)). + "a_key": "A String", + }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control "A String", @@ -2744,6 +2753,9 @@

Method Details

"A String", ], }, + "resourceManagerTags": { # Optional. Resource manager tags to add to all instances (see Resource manager tags resources (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)). + "a_key": "A String", + }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control "A String", @@ -3487,6 +3499,9 @@

Method Details

"A String", ], }, + "resourceManagerTags": { # Optional. Resource manager tags to add to all instances (see Resource manager tags resources (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)). + "a_key": "A String", + }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control "A String", @@ -4298,6 +4313,9 @@

Method Details

"A String", ], }, + "resourceManagerTags": { # Optional. Resource manager tags to add to all instances (see Resource manager tags resources (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)). + "a_key": "A String", + }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control "A String", @@ -5000,6 +5018,9 @@

Method Details

"A String", ], }, + "resourceManagerTags": { # Optional. Resource manager tags to add to all instances (see Resource manager tags resources (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)). + "a_key": "A String", + }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control "A String", diff --git a/docs/dyn/dataproc_v1.projects.regions.clusters.html b/docs/dyn/dataproc_v1.projects.regions.clusters.html index beb0af5dbc5..992cc83997e 100644 --- a/docs/dyn/dataproc_v1.projects.regions.clusters.html +++ b/docs/dyn/dataproc_v1.projects.regions.clusters.html @@ -264,6 +264,9 @@

Method Details

"A String", ], }, + "resourceManagerTags": { # Optional. Resource manager tags to add to all instances (see Resource manager tags resources (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)). + "a_key": "A String", + }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control "A String", @@ -915,6 +918,9 @@

Method Details

"A String", ], }, + "resourceManagerTags": { # Optional. Resource manager tags to add to all instances (see Resource manager tags resources (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)). + "a_key": "A String", + }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control "A String", @@ -1527,6 +1533,9 @@

Method Details

"A String", ], }, + "resourceManagerTags": { # Optional. Resource manager tags to add to all instances (see Resource manager tags resources (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)). + "a_key": "A String", + }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control "A String", @@ -2059,6 +2068,9 @@

Method Details

"A String", ], }, + "resourceManagerTags": { # Optional. Resource manager tags to add to all instances (see Resource manager tags resources (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)). + "a_key": "A String", + }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control "A String", diff --git a/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html b/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html index f7ac329ff05..35edcfb5bcc 100644 --- a/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html +++ b/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html @@ -520,6 +520,9 @@

Method Details

"A String", ], }, + "resourceManagerTags": { # Optional. Resource manager tags to add to all instances (see Resource manager tags resources (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)). + "a_key": "A String", + }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control "A String", @@ -1222,6 +1225,9 @@

Method Details

"A String", ], }, + "resourceManagerTags": { # Optional. Resource manager tags to add to all instances (see Resource manager tags resources (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)). + "a_key": "A String", + }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control "A String", @@ -1951,6 +1957,9 @@

Method Details

"A String", ], }, + "resourceManagerTags": { # Optional. Resource manager tags to add to all instances (see Resource manager tags resources (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)). + "a_key": "A String", + }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control "A String", @@ -2744,6 +2753,9 @@

Method Details

"A String", ], }, + "resourceManagerTags": { # Optional. Resource manager tags to add to all instances (see Resource manager tags resources (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)). + "a_key": "A String", + }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control "A String", @@ -3487,6 +3499,9 @@

Method Details

"A String", ], }, + "resourceManagerTags": { # Optional. Resource manager tags to add to all instances (see Resource manager tags resources (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)). + "a_key": "A String", + }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control "A String", @@ -4298,6 +4313,9 @@

Method Details

"A String", ], }, + "resourceManagerTags": { # Optional. Resource manager tags to add to all instances (see Resource manager tags resources (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)). + "a_key": "A String", + }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control "A String", @@ -5000,6 +5018,9 @@

Method Details

"A String", ], }, + "resourceManagerTags": { # Optional. Resource manager tags to add to all instances (see Resource manager tags resources (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)). + "a_key": "A String", + }, "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control "A String", diff --git a/googleapiclient/discovery_cache/documents/dataproc.v1.json b/googleapiclient/discovery_cache/documents/dataproc.v1.json index 4dd4bb5a0ae..83815870255 100644 --- a/googleapiclient/discovery_cache/documents/dataproc.v1.json +++ b/googleapiclient/discovery_cache/documents/dataproc.v1.json @@ -4978,7 +4978,7 @@ } } }, -"revision": "20250122", +"revision": "20250131", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -6938,6 +6938,13 @@ "$ref": "ReservationAffinity", "description": "Optional. Reservation Affinity for consuming Zonal reservation." }, +"resourceManagerTags": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Resource manager tags to add to all instances (see Resource manager tags resources (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)).", +"type": "object" +}, "serviceAccount": { "description": "Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.", "type": "string" From fc75340938766d722da9baf136bdbd461ee0c16f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:09 +0000 Subject: [PATCH 12/31] feat(datastream): update the api #### datastream:v1 The following keys were added: - schemas.MysqlGtidPosition (Total Keys: 3) - schemas.SpecificStartPosition.properties.mysqlGtidPosition.$ref (Total Keys: 1) --- ...atastream_v1.projects.locations.streams.html | 3 +++ .../documents/datastream.v1.json | 17 ++++++++++++++++- 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/dyn/datastream_v1.projects.locations.streams.html b/docs/dyn/datastream_v1.projects.locations.streams.html index 4d97bbf2cf5..60f922d0392 100644 --- a/docs/dyn/datastream_v1.projects.locations.streams.html +++ b/docs/dyn/datastream_v1.projects.locations.streams.html @@ -1889,6 +1889,9 @@

Method Details

"nextAvailableStartPosition": { # CDC strategy to resume replication from the next available position in the source. # Optional. Resume replication from the next available position in the source. }, "specificStartPosition": { # CDC strategy to start replicating from a specific position in the source. # Optional. Start replicating from a specific position in the source. + "mysqlGtidPosition": { # MySQL GTID position # MySQL GTID set to start replicating from. + "gtidSet": "A String", # Required. The gtid set to start replication from. + }, "mysqlLogPosition": { # MySQL log position # MySQL specific log position to start replicating from. "logFile": "A String", # Required. The binary log file name. "logPosition": 42, # Optional. The position within the binary log file. Default is head of file. diff --git a/googleapiclient/discovery_cache/documents/datastream.v1.json b/googleapiclient/discovery_cache/documents/datastream.v1.json index 09a543fc14e..0fe37132abc 100644 --- a/googleapiclient/discovery_cache/documents/datastream.v1.json +++ b/googleapiclient/discovery_cache/documents/datastream.v1.json @@ -1250,7 +1250,7 @@ } } }, -"revision": "20250122", +"revision": "20250202", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AppendOnly": { @@ -2093,6 +2093,17 @@ }, "type": "object" }, +"MysqlGtidPosition": { +"description": "MySQL GTID position", +"id": "MysqlGtidPosition", +"properties": { +"gtidSet": { +"description": "Required. The gtid set to start replication from.", +"type": "string" +} +}, +"type": "object" +}, "MysqlLogPosition": { "description": "MySQL log position", "id": "MysqlLogPosition", @@ -3048,6 +3059,10 @@ "description": "CDC strategy to start replicating from a specific position in the source.", "id": "SpecificStartPosition", "properties": { +"mysqlGtidPosition": { +"$ref": "MysqlGtidPosition", +"description": "MySQL GTID set to start replicating from." +}, "mysqlLogPosition": { "$ref": "MysqlLogPosition", "description": "MySQL specific log position to start replicating from." From cbbb7315a0a77eb3240c7842952ec41172ccba5e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:09 +0000 Subject: [PATCH 13/31] feat(firebaseml): update the api #### firebaseml:v2beta The following keys were deleted: - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.thinkingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig (Total Keys: 3) --- ...ta.projects.locations.publishers.models.html | 9 --------- .../documents/firebaseml.v2beta.json | 17 +---------------- 2 files changed, 1 insertion(+), 25 deletions(-) diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html index 35830c6b267..cc63f0748ec 100644 --- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -214,9 +214,6 @@

Method Details

"A String", ], "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - }, "topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, @@ -540,9 +537,6 @@

Method Details

"A String", ], "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - }, "topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, @@ -1061,9 +1055,6 @@

Method Details

"A String", ], "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - }, "topK": 3.14, # Optional. If specified, top-k sampling will be used. "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index 7ce57da370f..e0a288c034d 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20250122", +"revision": "20250203", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -940,10 +940,6 @@ "format": "float", "type": "number" }, -"thinkingConfig": { -"$ref": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig", -"description": "Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking." -}, "topK": { "description": "Optional. If specified, top-k sampling will be used.", "format": "float", @@ -1006,17 +1002,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig": { -"description": "Config for thinking features.", -"id": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig", -"properties": { -"includeThoughts": { -"description": "Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.", -"type": "boolean" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval": { "description": "Tool to retrieve public web data for grounding, powered by Google.", "id": "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval", From 77b7ca23cab8e21674cc5f5b9475001280a3cb89 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:09 +0000 Subject: [PATCH 14/31] feat(identitytoolkit): update the api #### identitytoolkit:v1 The following keys were added: - schemas.GoogleCloudIdentitytoolkitV1GetOobCodeRequest.properties.linkDomain.type (Total Keys: 1) #### identitytoolkit:v2 The following keys were added: - schemas.GoogleCloudIdentitytoolkitAdminV2Config.properties.defaultHostingSite (Total Keys: 2) - schemas.GoogleCloudIdentitytoolkitAdminV2Config.properties.mobileLinksConfig.$ref (Total Keys: 1) - schemas.GoogleCloudIdentitytoolkitAdminV2MobileLinksConfig (Total Keys: 3) - schemas.GoogleCloudIdentitytoolkitAdminV2Tenant.properties.mobileLinksConfig (Total Keys: 2) --- docs/dyn/identitytoolkit_v1.accounts.html | 5 ++- .../identitytoolkit_v1.projects.accounts.html | 13 ++++--- docs/dyn/identitytoolkit_v1.projects.html | 6 +-- ...ytoolkit_v1.projects.tenants.accounts.html | 13 ++++--- docs/dyn/identitytoolkit_v1.v1.html | 2 +- docs/dyn/identitytoolkit_v2.projects.html | 12 ++++++ .../identitytoolkit_v2.projects.tenants.html | 18 +++++++++ .../documents/identitytoolkit.v1.json | 13 +++---- .../documents/identitytoolkit.v2.json | 37 ++++++++++++++++++- 9 files changed, 92 insertions(+), 27 deletions(-) diff --git a/docs/dyn/identitytoolkit_v1.accounts.html b/docs/dyn/identitytoolkit_v1.accounts.html index 56b79168f33..0181356eaf8 100644 --- a/docs/dyn/identitytoolkit_v1.accounts.html +++ b/docs/dyn/identitytoolkit_v1.accounts.html @@ -258,7 +258,7 @@

Method Details

"email": [ # The email address of one or more accounts to fetch. The length of email should be less than 256 characters and in the format of `name@domain.tld`. The email should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec production. Should only be specified by authenticated requests from a developer. "A String", ], - "federatedUserId": [ # The federated user identifier of one or more accounts to fetch. Should only be specified by authenticated requests bearing a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control). + "federatedUserId": [ { # Federated user identifier at an Identity Provider. "providerId": "A String", # The ID of supported identity providers. This should be a provider ID enabled for sign-in, which is either from the list of [default supported IdPs](https://cloud.google.com/identity-platform/docs/reference/rest/v2/defaultSupportedIdps/list), or of the format `oidc.*` or `saml.*`. Some examples are `google.com`, `facebook.com`, `oidc.testapp`, and `saml.testapp`. "rawId": "A String", # The user ID of the account at the third-party Identity Provider specified by `provider_id`. @@ -412,6 +412,7 @@

Method Details

"iOSAppStoreId": "A String", # If an associated iOS app can handle the OOB code, the App Store id of this app. This will allow App Store to open to the correct app if the app is not yet installed. "iOSBundleId": "A String", # If an associated iOS app can handle the OOB code, the iOS bundle id of this app. This will allow the correct app to open if it is already installed. "idToken": "A String", # An ID token for the account. It is required for VERIFY_AND_CHANGE_EMAIL and VERIFY_EMAIL requests unless return_oob_link is set to true. + "linkDomain": "A String", # Optional. In order to ensure that the url used can be easily opened in iOS or Android, we create a Hosting link '/__/auth/links'. This optional field contains the domain to use when constructing a Hosting link. If not set, '.firebaseapp.com' domain will be used. "newEmail": "A String", # The email address the account is being updated to. Required only for VERIFY_AND_CHANGE_EMAIL requests. "recaptchaVersion": "A String", # The reCAPTCHA version of the reCAPTCHA token in the captcha_response. "requestType": "A String", # Required. The type of out-of-band (OOB) code to send. Depending on this value, other fields in this request will be required and/or have different meanings. There are 4 different OOB codes that can be sent: * PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL @@ -862,7 +863,7 @@

Method Details

"createdAt": "A String", # The timestamp in milliseconds when the account was created. "customAttributes": "A String", # JSON formatted custom attributes to be stored in the Identity Platform ID token. Specifying this field requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control). "delegatedProjectNumber": "A String", - "deleteAttribute": [ # The account's attributes to be deleted. + "deleteAttribute": [ "A String", ], "deleteProvider": [ # The Identity Providers to unlink from the user's account. diff --git a/docs/dyn/identitytoolkit_v1.projects.accounts.html b/docs/dyn/identitytoolkit_v1.projects.accounts.html index 857a2840f74..a7b2f72a7cf 100644 --- a/docs/dyn/identitytoolkit_v1.projects.accounts.html +++ b/docs/dyn/identitytoolkit_v1.projects.accounts.html @@ -132,7 +132,7 @@

Method Details

"hashAlgorithm": "A String", # Required. The hashing function used to hash the account passwords. Must be one of the following: * HMAC_SHA256 * HMAC_SHA1 * HMAC_MD5 * SCRYPT * PBKDF_SHA1 * MD5 * HMAC_SHA512 * SHA1 * BCRYPT * PBKDF2_SHA256 * SHA256 * SHA512 * STANDARD_SCRYPT * ARGON2 "memoryCost": 42, # Memory cost for hash calculation. Only required when the hashing function is SCRYPT. "parallelization": 42, # The parallelization cost parameter to be used by the STANDARD_SCRYPT hashing function. This parameter, along with block_size and cpu_mem_cost help tune the resources needed to hash a password, and should be tuned as processor speeds and memory technologies advance. - "passwordHashOrder": "A String", # Password and salt order when verify password. + "passwordHashOrder": "A String", "rounds": 42, # The number of rounds used for hash calculation. Only required for the following hashing functions: * MD5 * SHA1 * SHA256 * SHA512 * PBKDF_SHA1 * PBKDF2_SHA256 * SCRYPT "saltSeparator": "A String", # One or more bytes to be inserted between the salt and plain text password. For stronger security, this should be a single non-printable character. "sanityCheck": True or False, # If true, the service will do the following list of checks before an account is uploaded: * Duplicate emails * Duplicate federated IDs * Federated ID provider validation If the duplication exists within the list of accounts to be uploaded, it will prevent the entire list from being uploaded. If the email or federated ID is a duplicate of a user already within the project/tenant, the account will not be uploaded, but the rest of the accounts will be unaffected. If false, these checks will be skipped. @@ -392,7 +392,7 @@

Method Details

"email": [ # The email address of one or more accounts to fetch. The length of email should be less than 256 characters and in the format of `name@domain.tld`. The email should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec production. Should only be specified by authenticated requests from a developer. "A String", ], - "federatedUserId": [ # The federated user identifier of one or more accounts to fetch. Should only be specified by authenticated requests bearing a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control). + "federatedUserId": [ { # Federated user identifier at an Identity Provider. "providerId": "A String", # The ID of supported identity providers. This should be a provider ID enabled for sign-in, which is either from the list of [default supported IdPs](https://cloud.google.com/identity-platform/docs/reference/rest/v2/defaultSupportedIdps/list), or of the format `oidc.*` or `saml.*`. Some examples are `google.com`, `facebook.com`, `oidc.testapp`, and `saml.testapp`. "rawId": "A String", # The user ID of the account at the third-party Identity Provider specified by `provider_id`. @@ -490,7 +490,7 @@

Method Details

The object takes the form of: { # Request message for QueryUserInfo. - "expression": [ # Query conditions used to filter results. If more than one is passed, only the first SqlExpression is evaluated. + "expression": [ { # Query conditions used to filter results. "email": "A String", # A case insensitive string that the account's email should match. Only one of `email`, `phone_number`, or `user_id` should be specified in a SqlExpression. If more than one is specified, only the first (in that order) will be applied. "phoneNumber": "A String", # A string that the account's phone number should match. Only one of `email`, `phone_number`, or `user_id` should be specified in a SqlExpression. If more than one is specified, only the first (in that order) will be applied. @@ -499,9 +499,9 @@

Method Details

], "limit": "A String", # The maximum number of accounts to return with an upper limit of __500__. Defaults to _500_. Only valid when `return_user_info` is set to `true`. "offset": "A String", # The number of accounts to skip from the beginning of matching records. Only valid when `return_user_info` is set to `true`. - "order": "A String", # The order for sorting query result. Defaults to __ascending__ order. Only valid when `return_user_info` is set to `true`. + "order": "A String", "returnUserInfo": True or False, # If `true`, this request will return the accounts matching the query. If `false`, only the __count__ of accounts matching the query will be returned. Defaults to `true`. - "sortBy": "A String", # The field to use for sorting user accounts. Defaults to `USER_ID`. Note: when `phone_number` is specified in `expression`, the result ignores the sorting. Only valid when `return_user_info` is set to `true`. + "sortBy": "A String", "tenantId": "A String", # The ID of the tenant to which the result is scoped. } @@ -596,6 +596,7 @@

Method Details

"iOSAppStoreId": "A String", # If an associated iOS app can handle the OOB code, the App Store id of this app. This will allow App Store to open to the correct app if the app is not yet installed. "iOSBundleId": "A String", # If an associated iOS app can handle the OOB code, the iOS bundle id of this app. This will allow the correct app to open if it is already installed. "idToken": "A String", # An ID token for the account. It is required for VERIFY_AND_CHANGE_EMAIL and VERIFY_EMAIL requests unless return_oob_link is set to true. + "linkDomain": "A String", # Optional. In order to ensure that the url used can be easily opened in iOS or Android, we create a Hosting link '/__/auth/links'. This optional field contains the domain to use when constructing a Hosting link. If not set, '.firebaseapp.com' domain will be used. "newEmail": "A String", # The email address the account is being updated to. Required only for VERIFY_AND_CHANGE_EMAIL requests. "recaptchaVersion": "A String", # The reCAPTCHA version of the reCAPTCHA token in the captcha_response. "requestType": "A String", # Required. The type of out-of-band (OOB) code to send. Depending on this value, other fields in this request will be required and/or have different meanings. There are 4 different OOB codes that can be sent: * PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL @@ -636,7 +637,7 @@

Method Details

"createdAt": "A String", # The timestamp in milliseconds when the account was created. "customAttributes": "A String", # JSON formatted custom attributes to be stored in the Identity Platform ID token. Specifying this field requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control). "delegatedProjectNumber": "A String", - "deleteAttribute": [ # The account's attributes to be deleted. + "deleteAttribute": [ "A String", ], "deleteProvider": [ # The Identity Providers to unlink from the user's account. diff --git a/docs/dyn/identitytoolkit_v1.projects.html b/docs/dyn/identitytoolkit_v1.projects.html index 1a25df6589d..f159ddb6768 100644 --- a/docs/dyn/identitytoolkit_v1.projects.html +++ b/docs/dyn/identitytoolkit_v1.projects.html @@ -137,7 +137,7 @@

Method Details

The object takes the form of: { # Request message for QueryUserInfo. - "expression": [ # Query conditions used to filter results. If more than one is passed, only the first SqlExpression is evaluated. + "expression": [ { # Query conditions used to filter results. "email": "A String", # A case insensitive string that the account's email should match. Only one of `email`, `phone_number`, or `user_id` should be specified in a SqlExpression. If more than one is specified, only the first (in that order) will be applied. "phoneNumber": "A String", # A string that the account's phone number should match. Only one of `email`, `phone_number`, or `user_id` should be specified in a SqlExpression. If more than one is specified, only the first (in that order) will be applied. @@ -146,9 +146,9 @@

Method Details

], "limit": "A String", # The maximum number of accounts to return with an upper limit of __500__. Defaults to _500_. Only valid when `return_user_info` is set to `true`. "offset": "A String", # The number of accounts to skip from the beginning of matching records. Only valid when `return_user_info` is set to `true`. - "order": "A String", # The order for sorting query result. Defaults to __ascending__ order. Only valid when `return_user_info` is set to `true`. + "order": "A String", "returnUserInfo": True or False, # If `true`, this request will return the accounts matching the query. If `false`, only the __count__ of accounts matching the query will be returned. Defaults to `true`. - "sortBy": "A String", # The field to use for sorting user accounts. Defaults to `USER_ID`. Note: when `phone_number` is specified in `expression`, the result ignores the sorting. Only valid when `return_user_info` is set to `true`. + "sortBy": "A String", "tenantId": "A String", # The ID of the tenant to which the result is scoped. } diff --git a/docs/dyn/identitytoolkit_v1.projects.tenants.accounts.html b/docs/dyn/identitytoolkit_v1.projects.tenants.accounts.html index d9cba83d2bf..90e7163f0ef 100644 --- a/docs/dyn/identitytoolkit_v1.projects.tenants.accounts.html +++ b/docs/dyn/identitytoolkit_v1.projects.tenants.accounts.html @@ -133,7 +133,7 @@

Method Details

"hashAlgorithm": "A String", # Required. The hashing function used to hash the account passwords. Must be one of the following: * HMAC_SHA256 * HMAC_SHA1 * HMAC_MD5 * SCRYPT * PBKDF_SHA1 * MD5 * HMAC_SHA512 * SHA1 * BCRYPT * PBKDF2_SHA256 * SHA256 * SHA512 * STANDARD_SCRYPT * ARGON2 "memoryCost": 42, # Memory cost for hash calculation. Only required when the hashing function is SCRYPT. "parallelization": 42, # The parallelization cost parameter to be used by the STANDARD_SCRYPT hashing function. This parameter, along with block_size and cpu_mem_cost help tune the resources needed to hash a password, and should be tuned as processor speeds and memory technologies advance. - "passwordHashOrder": "A String", # Password and salt order when verify password. + "passwordHashOrder": "A String", "rounds": 42, # The number of rounds used for hash calculation. Only required for the following hashing functions: * MD5 * SHA1 * SHA256 * SHA512 * PBKDF_SHA1 * PBKDF2_SHA256 * SCRYPT "saltSeparator": "A String", # One or more bytes to be inserted between the salt and plain text password. For stronger security, this should be a single non-printable character. "sanityCheck": True or False, # If true, the service will do the following list of checks before an account is uploaded: * Duplicate emails * Duplicate federated IDs * Federated ID provider validation If the duplication exists within the list of accounts to be uploaded, it will prevent the entire list from being uploaded. If the email or federated ID is a duplicate of a user already within the project/tenant, the account will not be uploaded, but the rest of the accounts will be unaffected. If false, these checks will be skipped. @@ -396,7 +396,7 @@

Method Details

"email": [ # The email address of one or more accounts to fetch. The length of email should be less than 256 characters and in the format of `name@domain.tld`. The email should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec production. Should only be specified by authenticated requests from a developer. "A String", ], - "federatedUserId": [ # The federated user identifier of one or more accounts to fetch. Should only be specified by authenticated requests bearing a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control). + "federatedUserId": [ { # Federated user identifier at an Identity Provider. "providerId": "A String", # The ID of supported identity providers. This should be a provider ID enabled for sign-in, which is either from the list of [default supported IdPs](https://cloud.google.com/identity-platform/docs/reference/rest/v2/defaultSupportedIdps/list), or of the format `oidc.*` or `saml.*`. Some examples are `google.com`, `facebook.com`, `oidc.testapp`, and `saml.testapp`. "rawId": "A String", # The user ID of the account at the third-party Identity Provider specified by `provider_id`. @@ -495,7 +495,7 @@

Method Details

The object takes the form of: { # Request message for QueryUserInfo. - "expression": [ # Query conditions used to filter results. If more than one is passed, only the first SqlExpression is evaluated. + "expression": [ { # Query conditions used to filter results. "email": "A String", # A case insensitive string that the account's email should match. Only one of `email`, `phone_number`, or `user_id` should be specified in a SqlExpression. If more than one is specified, only the first (in that order) will be applied. "phoneNumber": "A String", # A string that the account's phone number should match. Only one of `email`, `phone_number`, or `user_id` should be specified in a SqlExpression. If more than one is specified, only the first (in that order) will be applied. @@ -504,9 +504,9 @@

Method Details

], "limit": "A String", # The maximum number of accounts to return with an upper limit of __500__. Defaults to _500_. Only valid when `return_user_info` is set to `true`. "offset": "A String", # The number of accounts to skip from the beginning of matching records. Only valid when `return_user_info` is set to `true`. - "order": "A String", # The order for sorting query result. Defaults to __ascending__ order. Only valid when `return_user_info` is set to `true`. + "order": "A String", "returnUserInfo": True or False, # If `true`, this request will return the accounts matching the query. If `false`, only the __count__ of accounts matching the query will be returned. Defaults to `true`. - "sortBy": "A String", # The field to use for sorting user accounts. Defaults to `USER_ID`. Note: when `phone_number` is specified in `expression`, the result ignores the sorting. Only valid when `return_user_info` is set to `true`. + "sortBy": "A String", "tenantId": "A String", # The ID of the tenant to which the result is scoped. } @@ -602,6 +602,7 @@

Method Details

"iOSAppStoreId": "A String", # If an associated iOS app can handle the OOB code, the App Store id of this app. This will allow App Store to open to the correct app if the app is not yet installed. "iOSBundleId": "A String", # If an associated iOS app can handle the OOB code, the iOS bundle id of this app. This will allow the correct app to open if it is already installed. "idToken": "A String", # An ID token for the account. It is required for VERIFY_AND_CHANGE_EMAIL and VERIFY_EMAIL requests unless return_oob_link is set to true. + "linkDomain": "A String", # Optional. In order to ensure that the url used can be easily opened in iOS or Android, we create a Hosting link '/__/auth/links'. This optional field contains the domain to use when constructing a Hosting link. If not set, '.firebaseapp.com' domain will be used. "newEmail": "A String", # The email address the account is being updated to. Required only for VERIFY_AND_CHANGE_EMAIL requests. "recaptchaVersion": "A String", # The reCAPTCHA version of the reCAPTCHA token in the captcha_response. "requestType": "A String", # Required. The type of out-of-band (OOB) code to send. Depending on this value, other fields in this request will be required and/or have different meanings. There are 4 different OOB codes that can be sent: * PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL @@ -643,7 +644,7 @@

Method Details

"createdAt": "A String", # The timestamp in milliseconds when the account was created. "customAttributes": "A String", # JSON formatted custom attributes to be stored in the Identity Platform ID token. Specifying this field requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control). "delegatedProjectNumber": "A String", - "deleteAttribute": [ # The account's attributes to be deleted. + "deleteAttribute": [ "A String", ], "deleteProvider": [ # The Identity Providers to unlink from the user's account. diff --git a/docs/dyn/identitytoolkit_v1.v1.html b/docs/dyn/identitytoolkit_v1.v1.html index dae5d5fdecf..7f03a80a02f 100644 --- a/docs/dyn/identitytoolkit_v1.v1.html +++ b/docs/dyn/identitytoolkit_v1.v1.html @@ -141,7 +141,7 @@

Method Details

"clientId": "A String", # OAuth2 client ID. "enabled": True or False, # True if allows the user to sign in with the provider. "experimentPercent": 42, # Percent of users who will be prompted/redirected federated login for this IdP - "provider": "A String", # Name of the identity provider. + "provider": "A String", "secret": "A String", # OAuth2 client secret. "whitelistedAudiences": [ # Whitelisted client IDs for audience check. "A String", diff --git a/docs/dyn/identitytoolkit_v2.projects.html b/docs/dyn/identitytoolkit_v2.projects.html index 1763a65aeb4..bb76e6fd1c0 100644 --- a/docs/dyn/identitytoolkit_v2.projects.html +++ b/docs/dyn/identitytoolkit_v2.projects.html @@ -154,6 +154,7 @@

Method Details

"disabledUserSignup": True or False, # When true, end users cannot sign up for a new account on the associated project through any of our API methods }, }, + "defaultHostingSite": "A String", # Output only. Default Firebase hosting site name "emailPrivacyConfig": { # Configuration for settings related to email privacy and public visibility. Settings in this config protect against email enumeration, but may make some trade-offs in user-friendliness. # Configuration for settings related to email privacy and public visibility. "enableImprovedEmailPrivacy": True or False, # Migrates the project to a state of improved email privacy. For example certain error codes are more generic to avoid giving away information on whether the account exists. In addition, this disables certain features that as a side-effect allow user enumeration. Enabling this toggle disables the fetchSignInMethodsForEmail functionality and changing the user's email to an unverified email. It is recommended to remove dependence on this functionality and enable this toggle to improve user privacy. }, @@ -171,6 +172,9 @@

Method Details

], "state": "A String", # Whether MultiFactor Authentication has been enabled for this project. }, + "mobileLinksConfig": { # Configuration mobile links. # Configuration for settings related to univeral links (iOS) and app links (Android). + "domain": "A String", # Open code in app domain to use for app links and universal links. + }, "monitoring": { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity. "requestLogging": { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging "enabled": True or False, # Whether logging is enabled for this project or not. @@ -378,6 +382,7 @@

Method Details

"disabledUserSignup": True or False, # When true, end users cannot sign up for a new account on the associated project through any of our API methods }, }, + "defaultHostingSite": "A String", # Output only. Default Firebase hosting site name "emailPrivacyConfig": { # Configuration for settings related to email privacy and public visibility. Settings in this config protect against email enumeration, but may make some trade-offs in user-friendliness. # Configuration for settings related to email privacy and public visibility. "enableImprovedEmailPrivacy": True or False, # Migrates the project to a state of improved email privacy. For example certain error codes are more generic to avoid giving away information on whether the account exists. In addition, this disables certain features that as a side-effect allow user enumeration. Enabling this toggle disables the fetchSignInMethodsForEmail functionality and changing the user's email to an unverified email. It is recommended to remove dependence on this functionality and enable this toggle to improve user privacy. }, @@ -395,6 +400,9 @@

Method Details

], "state": "A String", # Whether MultiFactor Authentication has been enabled for this project. }, + "mobileLinksConfig": { # Configuration mobile links. # Configuration for settings related to univeral links (iOS) and app links (Android). + "domain": "A String", # Open code in app domain to use for app links and universal links. + }, "monitoring": { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity. "requestLogging": { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging "enabled": True or False, # Whether logging is enabled for this project or not. @@ -601,6 +609,7 @@

Method Details

"disabledUserSignup": True or False, # When true, end users cannot sign up for a new account on the associated project through any of our API methods }, }, + "defaultHostingSite": "A String", # Output only. Default Firebase hosting site name "emailPrivacyConfig": { # Configuration for settings related to email privacy and public visibility. Settings in this config protect against email enumeration, but may make some trade-offs in user-friendliness. # Configuration for settings related to email privacy and public visibility. "enableImprovedEmailPrivacy": True or False, # Migrates the project to a state of improved email privacy. For example certain error codes are more generic to avoid giving away information on whether the account exists. In addition, this disables certain features that as a side-effect allow user enumeration. Enabling this toggle disables the fetchSignInMethodsForEmail functionality and changing the user's email to an unverified email. It is recommended to remove dependence on this functionality and enable this toggle to improve user privacy. }, @@ -618,6 +627,9 @@

Method Details

], "state": "A String", # Whether MultiFactor Authentication has been enabled for this project. }, + "mobileLinksConfig": { # Configuration mobile links. # Configuration for settings related to univeral links (iOS) and app links (Android). + "domain": "A String", # Open code in app domain to use for app links and universal links. + }, "monitoring": { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity. "requestLogging": { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging "enabled": True or False, # Whether logging is enabled for this project or not. diff --git a/docs/dyn/identitytoolkit_v2.projects.tenants.html b/docs/dyn/identitytoolkit_v2.projects.tenants.html index 3872d556b09..e7299fea9af 100644 --- a/docs/dyn/identitytoolkit_v2.projects.tenants.html +++ b/docs/dyn/identitytoolkit_v2.projects.tenants.html @@ -174,6 +174,9 @@

Method Details

], "state": "A String", # Whether MultiFactor Authentication has been enabled for this project. }, + "mobileLinksConfig": { # Configuration mobile links. # Optional. Deprecated. Never launched. Configuration for settings related to univeral links (iOS) and app links (Android). + "domain": "A String", # Open code in app domain to use for app links and universal links. + }, "monitoring": { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity. "requestLogging": { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging "enabled": True or False, # Whether logging is enabled for this project or not. @@ -288,6 +291,9 @@

Method Details

], "state": "A String", # Whether MultiFactor Authentication has been enabled for this project. }, + "mobileLinksConfig": { # Configuration mobile links. # Optional. Deprecated. Never launched. Configuration for settings related to univeral links (iOS) and app links (Android). + "domain": "A String", # Open code in app domain to use for app links and universal links. + }, "monitoring": { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity. "requestLogging": { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging "enabled": True or False, # Whether logging is enabled for this project or not. @@ -427,6 +433,9 @@

Method Details

], "state": "A String", # Whether MultiFactor Authentication has been enabled for this project. }, + "mobileLinksConfig": { # Configuration mobile links. # Optional. Deprecated. Never launched. Configuration for settings related to univeral links (iOS) and app links (Android). + "domain": "A String", # Open code in app domain to use for app links and universal links. + }, "monitoring": { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity. "requestLogging": { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging "enabled": True or False, # Whether logging is enabled for this project or not. @@ -609,6 +618,9 @@

Method Details

], "state": "A String", # Whether MultiFactor Authentication has been enabled for this project. }, + "mobileLinksConfig": { # Configuration mobile links. # Optional. Deprecated. Never launched. Configuration for settings related to univeral links (iOS) and app links (Android). + "domain": "A String", # Open code in app domain to use for app links and universal links. + }, "monitoring": { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity. "requestLogging": { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging "enabled": True or False, # Whether logging is enabled for this project or not. @@ -741,6 +753,9 @@

Method Details

], "state": "A String", # Whether MultiFactor Authentication has been enabled for this project. }, + "mobileLinksConfig": { # Configuration mobile links. # Optional. Deprecated. Never launched. Configuration for settings related to univeral links (iOS) and app links (Android). + "domain": "A String", # Open code in app domain to use for app links and universal links. + }, "monitoring": { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity. "requestLogging": { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging "enabled": True or False, # Whether logging is enabled for this project or not. @@ -856,6 +871,9 @@

Method Details

], "state": "A String", # Whether MultiFactor Authentication has been enabled for this project. }, + "mobileLinksConfig": { # Configuration mobile links. # Optional. Deprecated. Never launched. Configuration for settings related to univeral links (iOS) and app links (Android). + "domain": "A String", # Open code in app domain to use for app links and universal links. + }, "monitoring": { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity. "requestLogging": { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging "enabled": True or False, # Whether logging is enabled for this project or not. diff --git a/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json b/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json index 8229714a976..2c1f91a54f0 100644 --- a/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json +++ b/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json @@ -1239,7 +1239,7 @@ } } }, -"revision": "20241205", +"revision": "20250130", "rootUrl": "https://identitytoolkit.googleapis.com/", "schemas": { "GoogleCloudIdentitytoolkitV1Argon2Parameters": { @@ -1694,7 +1694,6 @@ "type": "array" }, "federatedUserId": { -"description": "The federated user identifier of one or more accounts to fetch. Should only be specified by authenticated requests bearing a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).", "items": { "$ref": "GoogleCloudIdentitytoolkitV1FederatedUserIdentifier" }, @@ -1822,6 +1821,10 @@ "description": "An ID token for the account. It is required for VERIFY_AND_CHANGE_EMAIL and VERIFY_EMAIL requests unless return_oob_link is set to true.", "type": "string" }, +"linkDomain": { +"description": "Optional. In order to ensure that the url used can be easily opened in iOS or Android, we create a Hosting link '/__/auth/links'. This optional field contains the domain to use when constructing a Hosting link. If not set, '.firebaseapp.com' domain will be used.", +"type": "string" +}, "newEmail": { "description": "The email address the account is being updated to. Required only for VERIFY_AND_CHANGE_EMAIL requests.", "type": "string" @@ -2037,7 +2040,6 @@ true "type": "integer" }, "provider": { -"description": "Name of the identity provider.", "enum": [ "PROVIDER_UNSPECIFIED", "MSLIVE", @@ -2276,7 +2278,6 @@ true "id": "GoogleCloudIdentitytoolkitV1QueryUserInfoRequest", "properties": { "expression": { -"description": "Query conditions used to filter results. If more than one is passed, only the first SqlExpression is evaluated.", "items": { "$ref": "GoogleCloudIdentitytoolkitV1SqlExpression" }, @@ -2293,7 +2294,6 @@ true "type": "string" }, "order": { -"description": "The order for sorting query result. Defaults to __ascending__ order. Only valid when `return_user_info` is set to `true`.", "enum": [ "ORDER_UNSPECIFIED", "ASC", @@ -2311,7 +2311,6 @@ true "type": "boolean" }, "sortBy": { -"description": "The field to use for sorting user accounts. Defaults to `USER_ID`. Note: when `phone_number` is specified in `expression`, the result ignores the sorting. Only valid when `return_user_info` is set to `true`.", "enum": [ "SORT_BY_FIELD_UNSPECIFIED", "USER_ID", @@ -2549,7 +2548,6 @@ true "type": "string" }, "deleteAttribute": { -"description": "The account's attributes to be deleted.", "items": { "enum": [ "USER_ATTRIBUTE_NAME_UNSPECIFIED", @@ -3638,7 +3636,6 @@ true "type": "integer" }, "passwordHashOrder": { -"description": "Password and salt order when verify password.", "enum": [ "UNSPECIFIED_ORDER", "SALT_AND_PASSWORD", diff --git a/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json b/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json index 1acc4d1fa98..013a7ada95d 100644 --- a/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json +++ b/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json @@ -1655,7 +1655,7 @@ } } }, -"revision": "20241024", +"revision": "20250130", "rootUrl": "https://identitytoolkit.googleapis.com/", "schemas": { "GoogleCloudIdentitytoolkitAdminV2AllowByDefault": { @@ -1822,6 +1822,11 @@ "$ref": "GoogleCloudIdentitytoolkitAdminV2ClientConfig", "description": "Options related to how clients making requests on behalf of a project should be configured." }, +"defaultHostingSite": { +"description": "Output only. Default Firebase hosting site name", +"readOnly": true, +"type": "string" +}, "emailPrivacyConfig": { "$ref": "GoogleCloudIdentitytoolkitAdminV2EmailPrivacyConfig", "description": "Configuration for settings related to email privacy and public visibility." @@ -1830,6 +1835,10 @@ "$ref": "GoogleCloudIdentitytoolkitAdminV2MultiFactorAuthConfig", "description": "Configuration for this project's multi-factor authentication, including whether it is active and what factors can be used for the second factor" }, +"mobileLinksConfig": { +"$ref": "GoogleCloudIdentitytoolkitAdminV2MobileLinksConfig", +"description": "Configuration for settings related to univeral links (iOS) and app links (Android)." +}, "monitoring": { "$ref": "GoogleCloudIdentitytoolkitAdminV2MonitoringConfig", "description": "Configuration related to monitoring project activity." @@ -2340,6 +2349,27 @@ }, "type": "object" }, +"GoogleCloudIdentitytoolkitAdminV2MobileLinksConfig": { +"description": "Configuration mobile links.", +"id": "GoogleCloudIdentitytoolkitAdminV2MobileLinksConfig", +"properties": { +"domain": { +"description": "Open code in app domain to use for app links and universal links.", +"enum": [ +"DOMAIN_UNSPECIFIED", +"FIREBASE_DYNAMIC_LINK_DOMAIN", +"HOSTING_DOMAIN" +], +"enumDescriptions": [ +"Default value. The default domain is the Firebase Dynamic Link domain before the FDL deprecation and the hosting domain after the FDL deprecation.", +"Use Firebase Dynamic Link domain as app link domain. Default value.", +"Use hosting domain as app link domain." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudIdentitytoolkitAdminV2MonitoringConfig": { "description": "Configuration related to monitoring project activity.", "id": "GoogleCloudIdentitytoolkitAdminV2MonitoringConfig", @@ -3045,6 +3075,11 @@ "$ref": "GoogleCloudIdentitytoolkitAdminV2MultiFactorAuthConfig", "description": "The tenant-level configuration of MFA options." }, +"mobileLinksConfig": { +"$ref": "GoogleCloudIdentitytoolkitAdminV2MobileLinksConfig", +"deprecated": true, +"description": "Optional. Deprecated. Never launched. Configuration for settings related to univeral links (iOS) and app links (Android)." +}, "monitoring": { "$ref": "GoogleCloudIdentitytoolkitAdminV2MonitoringConfig", "description": "Configuration related to monitoring project activity." From 9863d58765aec1ae3f7c5c9ee8731ec4e73a8b70 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:09 +0000 Subject: [PATCH 15/31] feat(logging): update the api #### logging:v2 The following keys were added: - schemas.AuditConfig (Total Keys: 5) - schemas.AuditLogConfig (Total Keys: 5) - schemas.Policy.properties.auditConfigs (Total Keys: 2) --- ...llingAccounts.locations.buckets.views.html | 2 +- ...ng_v2.folders.locations.buckets.views.html | 41 +++++++++++- .../logging_v2.locations.buckets.views.html | 41 +++++++++++- ...organizations.locations.buckets.views.html | 41 +++++++++++- ...g_v2.projects.locations.buckets.views.html | 41 +++++++++++- .../discovery_cache/documents/logging.v2.json | 67 +++++++++++++++++-- 6 files changed, 222 insertions(+), 11 deletions(-) diff --git a/docs/dyn/logging_v2.billingAccounts.locations.buckets.views.html b/docs/dyn/logging_v2.billingAccounts.locations.buckets.views.html index a333fd120c4..19b6edc7a8c 100644 --- a/docs/dyn/logging_v2.billingAccounts.locations.buckets.views.html +++ b/docs/dyn/logging_v2.billingAccounts.locations.buckets.views.html @@ -123,7 +123,7 @@

Method Details

"updateTime": "A String", # Output only. The last update timestamp of the view. } - viewId: string, Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens. + viewId: string, Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/logging_v2.folders.locations.buckets.views.html b/docs/dyn/logging_v2.folders.locations.buckets.views.html index cfef926d707..4aa08d4649f 100644 --- a/docs/dyn/logging_v2.folders.locations.buckets.views.html +++ b/docs/dyn/logging_v2.folders.locations.buckets.views.html @@ -132,7 +132,7 @@

Method Details

"updateTime": "A String", # Output only. The last update timestamp of the view. } - viewId: string, Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens. + viewId: string, Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +215,19 @@

Method Details

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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "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:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 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:jose@example.com" ] }, { "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:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com 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:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com 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:alice@example.com, 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). @@ -324,6 +337,19 @@

Method Details

{ # 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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "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:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 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:jose@example.com" ] }, { "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:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com 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:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com 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:alice@example.com, 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). @@ -353,6 +379,19 @@

Method Details

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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "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:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 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:jose@example.com" ] }, { "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:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com 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:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com 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:alice@example.com, 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). diff --git a/docs/dyn/logging_v2.locations.buckets.views.html b/docs/dyn/logging_v2.locations.buckets.views.html index 2579b0058f1..b72939bc971 100644 --- a/docs/dyn/logging_v2.locations.buckets.views.html +++ b/docs/dyn/logging_v2.locations.buckets.views.html @@ -127,7 +127,7 @@

Method Details

"updateTime": "A String", # Output only. The last update timestamp of the view. } - viewId: string, Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens. + viewId: string, Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -210,6 +210,19 @@

Method Details

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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "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:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 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:jose@example.com" ] }, { "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:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com 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:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com 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:alice@example.com, 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). @@ -319,6 +332,19 @@

Method Details

{ # 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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "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:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 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:jose@example.com" ] }, { "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:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com 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:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com 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:alice@example.com, 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). @@ -348,6 +374,19 @@

Method Details

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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "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:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 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:jose@example.com" ] }, { "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:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com 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:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com 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:alice@example.com, 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). diff --git a/docs/dyn/logging_v2.organizations.locations.buckets.views.html b/docs/dyn/logging_v2.organizations.locations.buckets.views.html index 1ef839c4a9d..918fadf3902 100644 --- a/docs/dyn/logging_v2.organizations.locations.buckets.views.html +++ b/docs/dyn/logging_v2.organizations.locations.buckets.views.html @@ -132,7 +132,7 @@

Method Details

"updateTime": "A String", # Output only. The last update timestamp of the view. } - viewId: string, Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens. + viewId: string, Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +215,19 @@

Method Details

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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "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:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 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:jose@example.com" ] }, { "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:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com 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:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com 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:alice@example.com, 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). @@ -324,6 +337,19 @@

Method Details

{ # 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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "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:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 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:jose@example.com" ] }, { "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:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com 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:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com 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:alice@example.com, 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). @@ -353,6 +379,19 @@

Method Details

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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "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:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 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:jose@example.com" ] }, { "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:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com 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:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com 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:alice@example.com, 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). diff --git a/docs/dyn/logging_v2.projects.locations.buckets.views.html b/docs/dyn/logging_v2.projects.locations.buckets.views.html index 0bd6e8144be..6641c1e40c6 100644 --- a/docs/dyn/logging_v2.projects.locations.buckets.views.html +++ b/docs/dyn/logging_v2.projects.locations.buckets.views.html @@ -132,7 +132,7 @@

Method Details

"updateTime": "A String", # Output only. The last update timestamp of the view. } - viewId: string, Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens. + viewId: string, Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +215,19 @@

Method Details

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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "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:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 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:jose@example.com" ] }, { "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:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com 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:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com 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:alice@example.com, 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). @@ -324,6 +337,19 @@

Method Details

{ # 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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "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:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 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:jose@example.com" ] }, { "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:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com 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:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com 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:alice@example.com, 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). @@ -353,6 +379,19 @@

Method Details

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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "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:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 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:jose@example.com" ] }, { "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:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com 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:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com 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:alice@example.com, 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). diff --git a/googleapiclient/discovery_cache/documents/logging.v2.json b/googleapiclient/discovery_cache/documents/logging.v2.json index 28b25422db3..5f8cfeab103 100644 --- a/googleapiclient/discovery_cache/documents/logging.v2.json +++ b/googleapiclient/discovery_cache/documents/logging.v2.json @@ -910,7 +910,7 @@ "type": "string" }, "viewId": { -"description": "Required. A client-assigned identifier such as \"my-view\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens.", +"description": "Required. A client-assigned identifier such as \"my-view\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", "location": "query", "type": "string" } @@ -2736,7 +2736,7 @@ "type": "string" }, "viewId": { -"description": "Required. A client-assigned identifier such as \"my-view\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens.", +"description": "Required. A client-assigned identifier such as \"my-view\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", "location": "query", "type": "string" } @@ -4317,7 +4317,7 @@ "type": "string" }, "viewId": { -"description": "Required. A client-assigned identifier such as \"my-view\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens.", +"description": "Required. A client-assigned identifier such as \"my-view\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", "location": "query", "type": "string" } @@ -5554,7 +5554,7 @@ "type": "string" }, "viewId": { -"description": "Required. A client-assigned identifier such as \"my-view\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens.", +"description": "Required. A client-assigned identifier such as \"my-view\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", "location": "query", "type": "string" } @@ -7356,7 +7356,7 @@ "type": "string" }, "viewId": { -"description": "Required. A client-assigned identifier such as \"my-view\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens.", +"description": "Required. A client-assigned identifier such as \"my-view\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", "location": "query", "type": "string" } @@ -8922,9 +8922,57 @@ } } }, -"revision": "20250124", +"revision": "20250204", "rootUrl": "https://logging.googleapis.com/", "schemas": { +"AuditConfig": { +"description": "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:jose@example.com\" ] }, { \"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:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.", +"id": "AuditConfig", +"properties": { +"auditLogConfigs": { +"description": "The configuration for logging of each type of permission.", +"items": { +"$ref": "AuditLogConfig" +}, +"type": "array" +}, +"service": { +"description": "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.", +"type": "string" +} +}, +"type": "object" +}, +"AuditLogConfig": { +"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", +"id": "AuditLogConfig", +"properties": { +"exemptedMembers": { +"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", +"items": { +"type": "string" +}, +"type": "array" +}, +"logType": { +"description": "The log type that this config enables.", +"enum": [ +"LOG_TYPE_UNSPECIFIED", +"ADMIN_READ", +"DATA_WRITE", +"DATA_READ" +], +"enumDescriptions": [ +"Default case. Should never be this.", +"Admin reads. Example: CloudIAM getIamPolicy", +"Data writes. Example: CloudSQL Users create", +"Data reads. Example: CloudSQL Users list" +], +"type": "string" +} +}, +"type": "object" +}, "BigQueryDataset": { "description": "Describes a BigQuery dataset that was created by a link.", "id": "BigQueryDataset", @@ -10879,6 +10927,13 @@ "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:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"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:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 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": "Policy", "properties": { +"auditConfigs": { +"description": "Specifies cloud audit logging configuration for this policy.", +"items": { +"$ref": "AuditConfig" +}, +"type": "array" +}, "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:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.", "items": { From 06db24e6d953c7ef5effd6cc62082c18b5dd8682 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:09 +0000 Subject: [PATCH 16/31] feat(memcache): update the api #### memcache:v1 The following keys were deleted: - schemas.AssetLocation (Total Keys: 10) - schemas.BlobstoreLocation (Total Keys: 4) - schemas.CloudAsset (Total Keys: 8) - schemas.DirectLocationAssignment (Total Keys: 4) - schemas.ExtraParameter (Total Keys: 3) - schemas.IsolationExpectations (Total Keys: 12) - schemas.LocationAssignment (Total Keys: 4) - schemas.LocationData (Total Keys: 8) - schemas.PlacerLocation (Total Keys: 3) - schemas.RegionalMigDistributionPolicy (Total Keys: 6) - schemas.RequirementOverride (Total Keys: 4) - schemas.SpannerLocation (Total Keys: 6) - schemas.TenantProjectProxy (Total Keys: 4) - schemas.ZoneConfiguration (Total Keys: 3) --- .../documents/memcache.v1.json | 390 +----------------- 1 file changed, 1 insertion(+), 389 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/memcache.v1.json b/googleapiclient/discovery_cache/documents/memcache.v1.json index 1f563c15049..b875e6929aa 100644 --- a/googleapiclient/discovery_cache/documents/memcache.v1.json +++ b/googleapiclient/discovery_cache/documents/memcache.v1.json @@ -584,7 +584,7 @@ } } }, -"revision": "20241010", +"revision": "20241106", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { @@ -605,85 +605,12 @@ }, "type": "object" }, -"AssetLocation": { -"description": "Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf.", -"id": "AssetLocation", -"properties": { -"ccfeRmsPath": { -"description": "Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata.", -"type": "string" -}, -"expected": { -"$ref": "IsolationExpectations", -"description": "Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation." -}, -"extraParameters": { -"description": "Defines extra parameters required for specific asset types.", -"items": { -"$ref": "ExtraParameter" -}, -"type": "array" -}, -"locationData": { -"description": "Contains all kinds of physical location definitions for this asset.", -"items": { -"$ref": "LocationData" -}, -"type": "array" -}, -"parentAsset": { -"description": "Defines parents assets if any in order to allow later generation of child_asset_location data via child assets.", -"items": { -"$ref": "CloudAsset" -}, -"type": "array" -} -}, -"type": "object" -}, -"BlobstoreLocation": { -"description": "Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains", -"id": "BlobstoreLocation", -"properties": { -"policyId": { -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", "properties": {}, "type": "object" }, -"CloudAsset": { -"id": "CloudAsset", -"properties": { -"assetName": { -"type": "string" -}, -"assetType": { -"type": "string" -} -}, -"type": "object" -}, -"CloudAssetComposition": { -"id": "CloudAssetComposition", -"properties": { -"childAsset": { -"items": { -"$ref": "CloudAsset" -}, -"type": "array" -} -}, -"type": "object" -}, "DailyCycle": { "description": "Time window specified for daily operations.", "id": "DailyCycle", @@ -741,35 +668,12 @@ }, "type": "object" }, -"DirectLocationAssignment": { -"id": "DirectLocationAssignment", -"properties": { -"location": { -"items": { -"$ref": "LocationAssignment" -}, -"type": "array" -} -}, -"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", "properties": {}, "type": "object" }, -"ExtraParameter": { -"description": "Defines parameters that should only be used for specific asset types.", -"id": "ExtraParameter", -"properties": { -"regionalMigDistributionPolicy": { -"$ref": "RegionalMigDistributionPolicy", -"description": "Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances." -} -}, -"type": "object" -}, "GoogleCloudMemcacheV1LocationMetadata": { "description": "Metadata for the given google.cloud.location.Location.", "id": "GoogleCloudMemcacheV1LocationMetadata", @@ -1328,131 +1232,6 @@ }, "type": "object" }, -"IsolationExpectations": { -"id": "IsolationExpectations", -"properties": { -"requirementOverride": { -"$ref": "RequirementOverride", -"description": "Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic." -}, -"ziOrgPolicy": { -"enum": [ -"ZI_UNSPECIFIED", -"ZI_UNKNOWN", -"ZI_NOT_REQUIRED", -"ZI_PREFERRED", -"ZI_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"", -"" -], -"type": "string" -}, -"ziRegionPolicy": { -"enum": [ -"ZI_REGION_POLICY_UNSPECIFIED", -"ZI_REGION_POLICY_UNKNOWN", -"ZI_REGION_POLICY_NOT_SET", -"ZI_REGION_POLICY_FAIL_OPEN", -"ZI_REGION_POLICY_FAIL_CLOSED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"", -"" -], -"type": "string" -}, -"ziRegionState": { -"enum": [ -"ZI_REGION_UNSPECIFIED", -"ZI_REGION_UNKNOWN", -"ZI_REGION_NOT_ENABLED", -"ZI_REGION_ENABLED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"" -], -"type": "string" -}, -"zoneIsolation": { -"deprecated": true, -"description": "Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location.", -"enum": [ -"ZI_UNSPECIFIED", -"ZI_UNKNOWN", -"ZI_NOT_REQUIRED", -"ZI_PREFERRED", -"ZI_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"", -"" -], -"type": "string" -}, -"zoneSeparation": { -"deprecated": true, -"description": "Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location.", -"enum": [ -"ZS_UNSPECIFIED", -"ZS_UNKNOWN", -"ZS_NOT_REQUIRED", -"ZS_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"" -], -"type": "string" -}, -"zsOrgPolicy": { -"enum": [ -"ZS_UNSPECIFIED", -"ZS_UNKNOWN", -"ZS_NOT_REQUIRED", -"ZS_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"" -], -"type": "string" -}, -"zsRegionState": { -"enum": [ -"ZS_REGION_UNSPECIFIED", -"ZS_REGION_UNKNOWN", -"ZS_REGION_NOT_ENABLED", -"ZS_REGION_ENABLED" -], -"enumDescriptions": [ -"", -"To be used if tracking of the asset ZS-bit is not available", -"", -"" -], -"type": "string" -} -}, -"type": "object" -}, "ListInstancesResponse": { "description": "Response for ListInstances.", "id": "ListInstancesResponse", @@ -1548,64 +1327,6 @@ }, "type": "object" }, -"LocationAssignment": { -"id": "LocationAssignment", -"properties": { -"location": { -"type": "string" -}, -"locationType": { -"enum": [ -"UNSPECIFIED", -"CLUSTER", -"POP", -"CLOUD_ZONE", -"CLOUD_REGION", -"MULTI_REGION_GEO", -"MULTI_REGION_JURISDICTION", -"GLOBAL", -"OTHER" -], -"enumDescriptions": [ -"", -"1-10: Physical failure domains.", -"", -"11-20: Logical failure domains.", -"", -"", -"", -"", -"" -], -"type": "string" -} -}, -"type": "object" -}, -"LocationData": { -"id": "LocationData", -"properties": { -"blobstoreLocation": { -"$ref": "BlobstoreLocation" -}, -"childAssetLocation": { -"$ref": "CloudAssetComposition" -}, -"directLocation": { -"$ref": "DirectLocationAssignment" -}, -"gcpProjectProxy": { -"$ref": "TenantProjectProxy" -}, -"placerLocation": { -"$ref": "PlacerLocation" -}, -"spannerLocation": { -"$ref": "SpannerLocation" -} -}, -"type": "object" -}, "LocationMetadata": { "description": "Metadata for the given google.cloud.location.Location.", "id": "LocationMetadata", @@ -1895,74 +1616,6 @@ }, "type": "object" }, -"PlacerLocation": { -"description": "Message describing that the location of the customer resource is tied to placer allocations", -"id": "PlacerLocation", -"properties": { -"placerConfig": { -"description": "Directory with a config related to it in placer (e.g. \"/placer/prod/home/my-root/my-dir\")", -"type": "string" -} -}, -"type": "object" -}, -"RegionalMigDistributionPolicy": { -"description": "To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances", -"id": "RegionalMigDistributionPolicy", -"properties": { -"targetShape": { -"description": "The shape in which the group converges around distribution of resources. Instance of proto2 enum", -"format": "int32", -"type": "integer" -}, -"zones": { -"description": "Cloud zones used by regional MIG to create instances.", -"items": { -"$ref": "ZoneConfiguration" -}, -"type": "array" -} -}, -"type": "object" -}, -"RequirementOverride": { -"id": "RequirementOverride", -"properties": { -"ziOverride": { -"enum": [ -"ZI_UNSPECIFIED", -"ZI_UNKNOWN", -"ZI_NOT_REQUIRED", -"ZI_PREFERRED", -"ZI_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"", -"" -], -"type": "string" -}, -"zsOverride": { -"enum": [ -"ZS_UNSPECIFIED", -"ZS_UNKNOWN", -"ZS_NOT_REQUIRED", -"ZS_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"" -], -"type": "string" -} -}, -"type": "object" -}, "RescheduleMaintenanceRequest": { "description": "Request for RescheduleMaintenance.", "id": "RescheduleMaintenanceRequest", @@ -2031,26 +1684,6 @@ }, "type": "object" }, -"SpannerLocation": { -"id": "SpannerLocation", -"properties": { -"backupName": { -"description": "Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata", -"items": { -"type": "string" -}, -"type": "array" -}, -"dbName": { -"description": "Set of databases used by the resource in format /span//", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"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", @@ -2078,18 +1711,6 @@ }, "type": "object" }, -"TenantProjectProxy": { -"id": "TenantProjectProxy", -"properties": { -"projectNumbers": { -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "TimeOfDay": { "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "id": "TimeOfDay", @@ -2225,15 +1846,6 @@ }, "type": "object" }, -"ZoneConfiguration": { -"id": "ZoneConfiguration", -"properties": { -"zone": { -"type": "string" -} -}, -"type": "object" -}, "ZoneMetadata": { "id": "ZoneMetadata", "properties": {}, From 845eef69857067ea02d59d06c87ce45632bdb33f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:09 +0000 Subject: [PATCH 17/31] feat(monitoring): update the api #### monitoring:v1 The following keys were added: - schemas.TemplateVariableCondition (Total Keys: 5) - schemas.VisibilityCondition (Total Keys: 3) - schemas.Widget.properties.visibilityCondition.$ref (Total Keys: 1) --- .../monitoring_v1.projects.dashboards.html | 168 ++++++++++++++++++ docs/dyn/monitoring_v3.projects.snoozes.html | 2 +- .../documents/monitoring.v1.json | 44 ++++- .../documents/monitoring.v3.json | 4 +- 4 files changed, 214 insertions(+), 4 deletions(-) diff --git a/docs/dyn/monitoring_v1.projects.dashboards.html b/docs/dyn/monitoring_v1.projects.dashboards.html index cde9050b669..9a8cc0cc24d 100644 --- a/docs/dyn/monitoring_v1.projects.dashboards.html +++ b/docs/dyn/monitoring_v1.projects.dashboards.html @@ -580,6 +580,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -1313,6 +1320,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -1942,6 +1956,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -2573,6 +2594,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -3229,6 +3257,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -3962,6 +3997,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -4591,6 +4633,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -5222,6 +5271,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -5902,6 +5958,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -6635,6 +6698,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -7264,6 +7334,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -7895,6 +7972,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -8561,6 +8645,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -9294,6 +9385,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -9923,6 +10021,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -10554,6 +10659,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -11228,6 +11340,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -11961,6 +12080,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -12590,6 +12716,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -13221,6 +13354,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -13877,6 +14017,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -14610,6 +14757,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -15239,6 +15393,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. @@ -15870,6 +16031,13 @@

Method Details

"metricVisualization": "A String", # Optional. Store rendering strategy }, "title": "A String", # Optional. The title of the widget. + "visibilityCondition": { # Condition that determines whether the widget should be displayed. # Optional. If set, this widget is rendered only when the condition is evaluated to true. + "templateVariableCondition": { # A condition whose evaluation is based on the value of a template variable. # A condition whose evaluation is based on the value of a template variable. + "comparator": "A String", # Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. + "templateVariable": "A String", # The template variable whose value is evaluated. + "templateVariableValue": "A String", # The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. + }, + }, "xyChart": { # A chart that displays data on a 2D (X and Y axes) plane. # A chart of time series data. "chartOptions": { # Options to control visual rendering of a chart. # Display options for the chart. "displayHorizontal": True or False, # Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release. diff --git a/docs/dyn/monitoring_v3.projects.snoozes.html b/docs/dyn/monitoring_v3.projects.snoozes.html index 608d9160c9d..a4675df9a33 100644 --- a/docs/dyn/monitoring_v3.projects.snoozes.html +++ b/docs/dyn/monitoring_v3.projects.snoozes.html @@ -182,7 +182,7 @@

Method Details

Args: parent: string, Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) whose Snoozes should be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] (required) - filter: string, Optional. Optional filter to restrict results to the given criteria. The following fields are supported. interval.start_time interval.end_timeFor example: ``` interval.start_time > "2022-03-11T00:00:00-08:00" AND interval.end_time < "2022-03-12T00:00:00-08:00" ``` + filter: string, Optional. Optional filter to restrict results to the given criteria. The following fields are supported. interval.start_time interval.end_timeFor example: interval.start_time > "2022-03-11T00:00:00-08:00" AND interval.end_time < "2022-03-12T00:00:00-08:00" pageSize: integer, Optional. The maximum number of results to return for a single query. The server may further constrain the maximum number of results returned in a single page. The value should be in the range 1, 1000. If the value given is outside this range, the server will decide the number of results to be returned. pageToken: string, Optional. The next_page_token from a previous call to ListSnoozesRequest to get the next page of results. x__xgafv: string, V1 error format. diff --git a/googleapiclient/discovery_cache/documents/monitoring.v1.json b/googleapiclient/discovery_cache/documents/monitoring.v1.json index 0befeebf541..60d6e4a2a75 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v1.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v1.json @@ -753,7 +753,7 @@ } } }, -"revision": "20250125", +"revision": "20250130", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -2452,6 +2452,33 @@ }, "type": "object" }, +"TemplateVariableCondition": { +"description": "A condition whose evaluation is based on the value of a template variable.", +"id": "TemplateVariableCondition", +"properties": { +"comparator": { +"description": "Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable.", +"enum": [ +"COMPARATOR_UNSPECIFIED", +"REGEX_FULL_MATCH" +], +"enumDescriptions": [ +"No comparator specified. Behavior defaults to REGEX_FULL_MATCH.", +"Condition with this comparator evaluates to true when the value of the template variables matches the specified regex." +], +"type": "string" +}, +"templateVariable": { +"description": "The template variable whose value is evaluated.", +"type": "string" +}, +"templateVariableValue": { +"description": "The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex.", +"type": "string" +} +}, +"type": "object" +}, "Text": { "description": "A widget that displays textual content.", "id": "Text", @@ -2871,6 +2898,17 @@ }, "type": "object" }, +"VisibilityCondition": { +"description": "Condition that determines whether the widget should be displayed.", +"id": "VisibilityCondition", +"properties": { +"templateVariableCondition": { +"$ref": "TemplateVariableCondition", +"description": "A condition whose evaluation is based on the value of a template variable." +} +}, +"type": "object" +}, "Widget": { "description": "Widget contains a single dashboard component and configuration of how to present the component in the dashboard.", "id": "Widget", @@ -2931,6 +2969,10 @@ "description": "Optional. The title of the widget.", "type": "string" }, +"visibilityCondition": { +"$ref": "VisibilityCondition", +"description": "Optional. If set, this widget is rendered only when the condition is evaluated to true." +}, "xyChart": { "$ref": "XyChart", "description": "A chart of time series data." diff --git a/googleapiclient/discovery_cache/documents/monitoring.v3.json b/googleapiclient/discovery_cache/documents/monitoring.v3.json index d97d6fa8e23..3b7bdf93e28 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v3.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v3.json @@ -1720,7 +1720,7 @@ ], "parameters": { "filter": { -"description": "Optional. Optional filter to restrict results to the given criteria. The following fields are supported. interval.start_time interval.end_timeFor example: ``` interval.start_time > \"2022-03-11T00:00:00-08:00\" AND interval.end_time < \"2022-03-12T00:00:00-08:00\" ``` ", +"description": "Optional. Optional filter to restrict results to the given criteria. The following fields are supported. interval.start_time interval.end_timeFor example: interval.start_time > \"2022-03-11T00:00:00-08:00\" AND interval.end_time < \"2022-03-12T00:00:00-08:00\" ", "location": "query", "type": "string" }, @@ -2720,7 +2720,7 @@ } } }, -"revision": "20250125", +"revision": "20250130", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { From ba4a46c1452fbf69ba0366c327abf16d3c9483f6 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:10 +0000 Subject: [PATCH 18/31] feat(netapp): update the api #### netapp:v1 The following keys were added: - schemas.LocationMetadata.properties.supportedFlexPerformance (Total Keys: 3) #### netapp:v1beta1 The following keys were added: - schemas.LocationMetadata.properties.supportedFlexPerformance (Total Keys: 3) --- .../discovery_cache/documents/netapp.v1.json | 20 ++++++++++++++++++- .../documents/netapp.v1beta1.json | 20 ++++++++++++++++++- 2 files changed, 38 insertions(+), 2 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/netapp.v1.json b/googleapiclient/discovery_cache/documents/netapp.v1.json index 27c654140ef..5063f6511d0 100644 --- a/googleapiclient/discovery_cache/documents/netapp.v1.json +++ b/googleapiclient/discovery_cache/documents/netapp.v1.json @@ -2264,7 +2264,7 @@ } } }, -"revision": "20250123", +"revision": "20250129", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -3254,6 +3254,24 @@ "description": "Metadata for a given google.cloud.location.Location.", "id": "LocationMetadata", "properties": { +"supportedFlexPerformance": { +"description": "Output only. Supported flex performance in a location.", +"items": { +"enum": [ +"FLEX_PERFORMANCE_UNSPECIFIED", +"FLEX_PERFORMANCE_DEFAULT", +"FLEX_PERFORMANCE_CUSTOM" +], +"enumDescriptions": [ +"Unspecified flex performance.", +"Flex Storage Pool with default performance.", +"Flex Storage Pool with custom performance." +], +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "supportedServiceLevels": { "description": "Output only. Supported service levels in a location.", "items": { diff --git a/googleapiclient/discovery_cache/documents/netapp.v1beta1.json b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json index 0d32598d396..028cb9408f3 100644 --- a/googleapiclient/discovery_cache/documents/netapp.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json @@ -2264,7 +2264,7 @@ } } }, -"revision": "20250123", +"revision": "20250129", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -3254,6 +3254,24 @@ "description": "Metadata for a given google.cloud.location.Location.", "id": "LocationMetadata", "properties": { +"supportedFlexPerformance": { +"description": "Output only. Supported flex performance in a location.", +"items": { +"enum": [ +"FLEX_PERFORMANCE_UNSPECIFIED", +"FLEX_PERFORMANCE_DEFAULT", +"FLEX_PERFORMANCE_CUSTOM" +], +"enumDescriptions": [ +"Unspecified flex performance.", +"Flex Storage Pool with default performance.", +"Flex Storage Pool with custom performance." +], +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "supportedServiceLevels": { "description": "Output only. Supported service levels in a location.", "items": { From 14dbbe96c307cee7e0fda909b94fed37cdbffae1 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:10 +0000 Subject: [PATCH 19/31] feat(pubsub): update the api #### pubsub:v1 The following keys were added: - schemas.JavaScriptUDF (Total Keys: 4) - schemas.MessageTransform (Total Keys: 4) - schemas.Subscription.properties.messageTransforms (Total Keys: 2) - schemas.Topic.properties.messageTransforms (Total Keys: 2) --- .../dyn/pubsub_v1.projects.subscriptions.html | 62 +++++++++++++++++-- docs/dyn/pubsub_v1.projects.topics.html | 62 +++++++++++++++++-- .../discovery_cache/documents/pubsub.v1.json | 46 +++++++++++++- 3 files changed, 161 insertions(+), 9 deletions(-) diff --git a/docs/dyn/pubsub_v1.projects.subscriptions.html b/docs/dyn/pubsub_v1.projects.subscriptions.html index 282116bde01..162ed9249a8 100644 --- a/docs/dyn/pubsub_v1.projects.subscriptions.html +++ b/docs/dyn/pubsub_v1.projects.subscriptions.html @@ -81,7 +81,7 @@

Instance Methods

close()

Close httplib2 connections.

- create(name, body=None, x__xgafv=None)

+ create(name, body, x__xgafv=None)

Creates a subscription to a given topic. See the [resource name rules] (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the [resource name format] (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.

delete(subscription, x__xgafv=None)

@@ -108,7 +108,7 @@

Instance Methods

modifyPushConfig(subscription, body=None, x__xgafv=None)

Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.

- patch(name, body=None, x__xgafv=None)

+ patch(name, body, x__xgafv=None)

Updates an existing subscription by updating the fields specified in the update mask. Note that certain properties of a subscription, such as its topic, are not modifiable.

pull(subscription, body=None, x__xgafv=None)

@@ -156,7 +156,7 @@

Method Details

- create(name, body=None, x__xgafv=None) + create(name, body, x__xgafv=None)
Creates a subscription to a given topic. See the [resource name rules] (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the [resource name format] (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.
 
 Args:
@@ -211,6 +211,15 @@ 

Method Details

"a_key": "A String", }, "messageRetentionDuration": "A String", # Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes. + "messageTransforms": [ # Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified. + { # All supported message transforms types. + "enabled": True or False, # Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`. + "javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`. + "code": "A String", # Required. JavaScript code that contains a function `function_name` with the below signature: /** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { } + "functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages. + }, + }, + ], "name": "A String", # Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. "pushConfig": { # Configuration for a push delivery endpoint. # Optional. If push delivery is used with this subscription, this field is used to configure it. "attributes": { # Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: `attributes { "x-goog-version": "v1" }` @@ -292,6 +301,15 @@

Method Details

"a_key": "A String", }, "messageRetentionDuration": "A String", # Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes. + "messageTransforms": [ # Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified. + { # All supported message transforms types. + "enabled": True or False, # Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`. + "javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`. + "code": "A String", # Required. JavaScript code that contains a function `function_name` with the below signature: /** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { } + "functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages. + }, + }, + ], "name": "A String", # Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. "pushConfig": { # Configuration for a push delivery endpoint. # Optional. If push delivery is used with this subscription, this field is used to configure it. "attributes": { # Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: `attributes { "x-goog-version": "v1" }` @@ -416,6 +434,15 @@

Method Details

"a_key": "A String", }, "messageRetentionDuration": "A String", # Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes. + "messageTransforms": [ # Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified. + { # All supported message transforms types. + "enabled": True or False, # Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`. + "javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`. + "code": "A String", # Required. JavaScript code that contains a function `function_name` with the below signature: /** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { } + "functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages. + }, + }, + ], "name": "A String", # Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. "pushConfig": { # Configuration for a push delivery endpoint. # Optional. If push delivery is used with this subscription, this field is used to configure it. "attributes": { # Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: `attributes { "x-goog-version": "v1" }` @@ -544,6 +571,15 @@

Method Details

"a_key": "A String", }, "messageRetentionDuration": "A String", # Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes. + "messageTransforms": [ # Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified. + { # All supported message transforms types. + "enabled": True or False, # Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`. + "javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`. + "code": "A String", # Required. JavaScript code that contains a function `function_name` with the below signature: /** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { } + "functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages. + }, + }, + ], "name": "A String", # Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. "pushConfig": { # Configuration for a push delivery endpoint. # Optional. If push delivery is used with this subscription, this field is used to configure it. "attributes": { # Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: `attributes { "x-goog-version": "v1" }` @@ -655,7 +691,7 @@

Method Details

- patch(name, body=None, x__xgafv=None) + patch(name, body, x__xgafv=None)
Updates an existing subscription by updating the fields specified in the update mask. Note that certain properties of a subscription, such as its topic, are not modifiable.
 
 Args:
@@ -711,6 +747,15 @@ 

Method Details

"a_key": "A String", }, "messageRetentionDuration": "A String", # Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes. + "messageTransforms": [ # Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified. + { # All supported message transforms types. + "enabled": True or False, # Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`. + "javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`. + "code": "A String", # Required. JavaScript code that contains a function `function_name` with the below signature: /** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { } + "functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages. + }, + }, + ], "name": "A String", # Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. "pushConfig": { # Configuration for a push delivery endpoint. # Optional. If push delivery is used with this subscription, this field is used to configure it. "attributes": { # Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: `attributes { "x-goog-version": "v1" }` @@ -794,6 +839,15 @@

Method Details

"a_key": "A String", }, "messageRetentionDuration": "A String", # Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes. + "messageTransforms": [ # Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified. + { # All supported message transforms types. + "enabled": True or False, # Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`. + "javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`. + "code": "A String", # Required. JavaScript code that contains a function `function_name` with the below signature: /** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { } + "functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages. + }, + }, + ], "name": "A String", # Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. "pushConfig": { # Configuration for a push delivery endpoint. # Optional. If push delivery is used with this subscription, this field is used to configure it. "attributes": { # Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: `attributes { "x-goog-version": "v1" }` diff --git a/docs/dyn/pubsub_v1.projects.topics.html b/docs/dyn/pubsub_v1.projects.topics.html index bb30c3138a4..81cd1cfa078 100644 --- a/docs/dyn/pubsub_v1.projects.topics.html +++ b/docs/dyn/pubsub_v1.projects.topics.html @@ -88,7 +88,7 @@

Instance Methods

close()

Close httplib2 connections.

- create(name, body=None, x__xgafv=None)

+ create(name, body, x__xgafv=None)

Creates the given topic with the given name. See the [resource name rules] (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).

delete(topic, x__xgafv=None)

@@ -106,7 +106,7 @@

Instance Methods

list_next()

Retrieves the next page of results.

- patch(name, body=None, x__xgafv=None)

+ patch(name, body, x__xgafv=None)

Updates an existing topic by updating the fields specified in the update mask. Note that certain properties of a topic are not modifiable.

publish(topic, body=None, x__xgafv=None)

@@ -124,7 +124,7 @@

Method Details

- create(name, body=None, x__xgafv=None) + create(name, body, x__xgafv=None)
Creates the given topic with the given name. See the [resource name rules] (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
 
 Args:
@@ -194,6 +194,15 @@ 

Method Details

], "enforceInTransit": True or False, # Optional. If true, `allowed_persistence_regions` is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in `allowed_persistence_regions`. }, + "messageTransforms": [ # Optional. Transforms to be applied to messages published to the topic. Transforms are applied in the order specified. + { # All supported message transforms types. + "enabled": True or False, # Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`. + "javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`. + "code": "A String", # Required. JavaScript code that contains a function `function_name` with the below signature: /** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { } + "functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages. + }, + }, + ], "name": "A String", # Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. "satisfiesPzs": True or False, # Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. "schemaSettings": { # Settings for validating messages published against a schema. # Optional. Settings for validating messages published against a schema. @@ -275,6 +284,15 @@

Method Details

], "enforceInTransit": True or False, # Optional. If true, `allowed_persistence_regions` is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in `allowed_persistence_regions`. }, + "messageTransforms": [ # Optional. Transforms to be applied to messages published to the topic. Transforms are applied in the order specified. + { # All supported message transforms types. + "enabled": True or False, # Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`. + "javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`. + "code": "A String", # Required. JavaScript code that contains a function `function_name` with the below signature: /** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { } + "functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages. + }, + }, + ], "name": "A String", # Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. "satisfiesPzs": True or False, # Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. "schemaSettings": { # Settings for validating messages published against a schema. # Optional. Settings for validating messages published against a schema. @@ -381,6 +399,15 @@

Method Details

], "enforceInTransit": True or False, # Optional. If true, `allowed_persistence_regions` is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in `allowed_persistence_regions`. }, + "messageTransforms": [ # Optional. Transforms to be applied to messages published to the topic. Transforms are applied in the order specified. + { # All supported message transforms types. + "enabled": True or False, # Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`. + "javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`. + "code": "A String", # Required. JavaScript code that contains a function `function_name` with the below signature: /** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { } + "functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages. + }, + }, + ], "name": "A String", # Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. "satisfiesPzs": True or False, # Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. "schemaSettings": { # Settings for validating messages published against a schema. # Optional. Settings for validating messages published against a schema. @@ -509,6 +536,15 @@

Method Details

], "enforceInTransit": True or False, # Optional. If true, `allowed_persistence_regions` is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in `allowed_persistence_regions`. }, + "messageTransforms": [ # Optional. Transforms to be applied to messages published to the topic. Transforms are applied in the order specified. + { # All supported message transforms types. + "enabled": True or False, # Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`. + "javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`. + "code": "A String", # Required. JavaScript code that contains a function `function_name` with the below signature: /** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { } + "functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages. + }, + }, + ], "name": "A String", # Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. "satisfiesPzs": True or False, # Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. "schemaSettings": { # Settings for validating messages published against a schema. # Optional. Settings for validating messages published against a schema. @@ -538,7 +574,7 @@

Method Details

- patch(name, body=None, x__xgafv=None) + patch(name, body, x__xgafv=None)
Updates an existing topic by updating the fields specified in the update mask. Note that certain properties of a topic are not modifiable.
 
 Args:
@@ -609,6 +645,15 @@ 

Method Details

], "enforceInTransit": True or False, # Optional. If true, `allowed_persistence_regions` is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in `allowed_persistence_regions`. }, + "messageTransforms": [ # Optional. Transforms to be applied to messages published to the topic. Transforms are applied in the order specified. + { # All supported message transforms types. + "enabled": True or False, # Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`. + "javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`. + "code": "A String", # Required. JavaScript code that contains a function `function_name` with the below signature: /** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { } + "functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages. + }, + }, + ], "name": "A String", # Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. "satisfiesPzs": True or False, # Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. "schemaSettings": { # Settings for validating messages published against a schema. # Optional. Settings for validating messages published against a schema. @@ -692,6 +737,15 @@

Method Details

], "enforceInTransit": True or False, # Optional. If true, `allowed_persistence_regions` is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in `allowed_persistence_regions`. }, + "messageTransforms": [ # Optional. Transforms to be applied to messages published to the topic. Transforms are applied in the order specified. + { # All supported message transforms types. + "enabled": True or False, # Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`. + "javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`. + "code": "A String", # Required. JavaScript code that contains a function `function_name` with the below signature: /** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { } + "functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages. + }, + }, + ], "name": "A String", # Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. "satisfiesPzs": True or False, # Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. "schemaSettings": { # Settings for validating messages published against a schema. # Optional. Settings for validating messages published against a schema. diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1.json b/googleapiclient/discovery_cache/documents/pubsub.v1.json index d4fd2d291aa..06a380a7652 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1.json @@ -1638,7 +1638,7 @@ } } }, -"revision": "20241231", +"revision": "20250128", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { @@ -2210,6 +2210,21 @@ }, "type": "object" }, +"JavaScriptUDF": { +"description": "User-defined JavaScript function that can transform or filter a Pub/Sub message.", +"id": "JavaScriptUDF", +"properties": { +"code": { +"description": "Required. JavaScript code that contains a function `function_name` with the below signature: /** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { }", +"type": "string" +}, +"functionName": { +"description": "Required. Name of the JavasScript function that should applied to Pub/Sub messages.", +"type": "string" +} +}, +"type": "object" +}, "ListSchemaRevisionsResponse": { "description": "Response for the `ListSchemaRevisions` method.", "id": "ListSchemaRevisionsResponse", @@ -2354,6 +2369,21 @@ }, "type": "object" }, +"MessageTransform": { +"description": "All supported message transforms types.", +"id": "MessageTransform", +"properties": { +"enabled": { +"description": "Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`.", +"type": "boolean" +}, +"javascriptUdf": { +"$ref": "JavaScriptUDF", +"description": "Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`." +} +}, +"type": "object" +}, "ModifyAckDeadlineRequest": { "description": "Request for the ModifyAckDeadline method.", "id": "ModifyAckDeadlineRequest", @@ -2833,6 +2863,13 @@ "format": "google-duration", "type": "string" }, +"messageTransforms": { +"description": "Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified.", +"items": { +"$ref": "MessageTransform" +}, +"type": "array" +}, "name": { "description": "Required. The name of the subscription. It must have the format `\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", "type": "string" @@ -2950,6 +2987,13 @@ "$ref": "MessageStoragePolicy", "description": "Optional. Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect." }, +"messageTransforms": { +"description": "Optional. Transforms to be applied to messages published to the topic. Transforms are applied in the order specified.", +"items": { +"$ref": "MessageTransform" +}, +"type": "array" +}, "name": { "description": "Required. The name of the topic. It must have the format `\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", "type": "string" From c4b46b0126de181135642533c75b4dbcad484df1 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:10 +0000 Subject: [PATCH 20/31] feat(recaptchaenterprise): update the api #### recaptchaenterprise:v1 The following keys were added: - schemas.GoogleCloudRecaptchaenterpriseV1Event.properties.ja4.type (Total Keys: 1) --- .../recaptchaenterprise_v1.projects.assessments.html | 6 ++++-- .../documents/recaptchaenterprise.v1.json | 10 +++++++--- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html index ff593a2453b..e7cee55c3ec 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html @@ -166,7 +166,8 @@

Method Details

"headers": [ # Optional. HTTP header information about the request. "A String", ], - "ja3": "A String", # Optional. JA3 fingerprint for SSL clients. + "ja3": "A String", # Optional. JA3 fingerprint for SSL clients. To learn how to compute this fingerprint, please refer to https://github.com/salesforce/ja3. + "ja4": "A String", # Optional. JA4 fingerprint for SSL clients. To learn how to compute this fingerprint, please refer to https://github.com/FoxIO-LLC/ja4. "requestedUri": "A String", # Optional. The URI resource the user requested that triggered an assessment. "siteKey": "A String", # Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token. "token": "A String", # Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site. @@ -383,7 +384,8 @@

Method Details

"headers": [ # Optional. HTTP header information about the request. "A String", ], - "ja3": "A String", # Optional. JA3 fingerprint for SSL clients. + "ja3": "A String", # Optional. JA3 fingerprint for SSL clients. To learn how to compute this fingerprint, please refer to https://github.com/salesforce/ja3. + "ja4": "A String", # Optional. JA4 fingerprint for SSL clients. To learn how to compute this fingerprint, please refer to https://github.com/FoxIO-LLC/ja4. "requestedUri": "A String", # Optional. The URI resource the user requested that triggered an assessment. "siteKey": "A String", # Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token. "token": "A String", # Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site. diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json index be5c8d6471b..4ae197db57f 100644 --- a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json @@ -786,7 +786,7 @@ } } }, -"revision": "20241208", +"revision": "20250202", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -1177,7 +1177,7 @@ true "enumDescriptions": [ "Default, unspecified setting. `fraud_prevention_assessment` is returned if `transaction_data` is present in `Event` and Fraud Prevention is enabled in the Google Cloud console.", "Enable Fraud Prevention for this assessment, if Fraud Prevention is enabled in the Google Cloud console.", -"Disable Fraud Prevention for this assessment, regardless of Google Cloud console settings." +"Disable Fraud Prevention for this assessment, regardless of the Google Cloud console settings." ], "type": "string" }, @@ -1195,7 +1195,11 @@ true "type": "array" }, "ja3": { -"description": "Optional. JA3 fingerprint for SSL clients.", +"description": "Optional. JA3 fingerprint for SSL clients. To learn how to compute this fingerprint, please refer to https://github.com/salesforce/ja3.", +"type": "string" +}, +"ja4": { +"description": "Optional. JA4 fingerprint for SSL clients. To learn how to compute this fingerprint, please refer to https://github.com/FoxIO-LLC/ja4.", "type": "string" }, "requestedUri": { From 701a45e20783a12626fa85976c2b381ca8ef7220 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:10 +0000 Subject: [PATCH 21/31] feat(run): update the api #### run:v1 The following keys were added: - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.pubsubTopic.type (Total Keys: 1) #### run:v2 The following keys were added: - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.pubsubTopic.type (Total Keys: 1) --- docs/dyn/run_v2.projects.locations.jobs.executions.html | 4 ++-- .../run_v2.projects.locations.jobs.executions.tasks.html | 4 ++-- docs/dyn/run_v2.projects.locations.jobs.html | 8 ++++---- docs/dyn/run_v2.projects.locations.services.html | 8 ++++---- .../dyn/run_v2.projects.locations.services.revisions.html | 4 ++-- .../run_v2.projects.locations.workerPools.revisions.html | 4 ++-- googleapiclient/discovery_cache/documents/run.v1.json | 6 +++++- googleapiclient/discovery_cache/documents/run.v2.json | 8 ++++++-- 8 files changed, 27 insertions(+), 19 deletions(-) diff --git a/docs/dyn/run_v2.projects.locations.jobs.executions.html b/docs/dyn/run_v2.projects.locations.jobs.executions.html index 010ad5addab..021c7230b4f 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.executions.html +++ b/docs/dyn/run_v2.projects.locations.jobs.executions.html @@ -283,7 +283,7 @@

Method Details

"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. "A String", ], - "baseImageUri": "A String", # Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update. + "baseImageUri": "A String", # Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. "buildInfo": { # Build information of the image. # Output only. The build info of the container image. "functionTarget": "A String", # Output only. Entry point of the function when the image is a Cloud Run function. "sourceLocation": "A String", # Output only. Source code location of the image. @@ -503,7 +503,7 @@

Method Details

"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. "A String", ], - "baseImageUri": "A String", # Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update. + "baseImageUri": "A String", # Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. "buildInfo": { # Build information of the image. # Output only. The build info of the container image. "functionTarget": "A String", # Output only. Entry point of the function when the image is a Cloud Run function. "sourceLocation": "A String", # Output only. Source code location of the image. diff --git a/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html b/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html index b1558dbca2d..b13b2652ad4 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html +++ b/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html @@ -128,7 +128,7 @@

Method Details

"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. "A String", ], - "baseImageUri": "A String", # Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update. + "baseImageUri": "A String", # Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. "buildInfo": { # Build information of the image. # Output only. The build info of the container image. "functionTarget": "A String", # Output only. Entry point of the function when the image is a Cloud Run function. "sourceLocation": "A String", # Output only. Source code location of the image. @@ -354,7 +354,7 @@

Method Details

"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. "A String", ], - "baseImageUri": "A String", # Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update. + "baseImageUri": "A String", # Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. "buildInfo": { # Build information of the image. # Output only. The build info of the container image. "functionTarget": "A String", # Output only. Entry point of the function when the image is a Cloud Run function. "sourceLocation": "A String", # Output only. Source code location of the image. diff --git a/docs/dyn/run_v2.projects.locations.jobs.html b/docs/dyn/run_v2.projects.locations.jobs.html index 2e8cac28c29..0fa1a2846f1 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.html +++ b/docs/dyn/run_v2.projects.locations.jobs.html @@ -190,7 +190,7 @@

Method Details

"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. "A String", ], - "baseImageUri": "A String", # Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update. + "baseImageUri": "A String", # Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. "buildInfo": { # Build information of the image. # Output only. The build info of the container image. "functionTarget": "A String", # Output only. Entry point of the function when the image is a Cloud Run function. "sourceLocation": "A String", # Output only. Source code location of the image. @@ -499,7 +499,7 @@

Method Details

"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. "A String", ], - "baseImageUri": "A String", # Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update. + "baseImageUri": "A String", # Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. "buildInfo": { # Build information of the image. # Output only. The build info of the container image. "functionTarget": "A String", # Output only. Entry point of the function when the image is a Cloud Run function. "sourceLocation": "A String", # Output only. Source code location of the image. @@ -794,7 +794,7 @@

Method Details

"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. "A String", ], - "baseImageUri": "A String", # Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update. + "baseImageUri": "A String", # Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. "buildInfo": { # Build information of the image. # Output only. The build info of the container image. "functionTarget": "A String", # Output only. Entry point of the function when the image is a Cloud Run function. "sourceLocation": "A String", # Output only. Source code location of the image. @@ -1048,7 +1048,7 @@

Method Details

"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. "A String", ], - "baseImageUri": "A String", # Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update. + "baseImageUri": "A String", # Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. "buildInfo": { # Build information of the image. # Output only. The build info of the container image. "functionTarget": "A String", # Output only. Entry point of the function when the image is a Cloud Run function. "sourceLocation": "A String", # Output only. Source code location of the image. diff --git a/docs/dyn/run_v2.projects.locations.services.html b/docs/dyn/run_v2.projects.locations.services.html index cb6f013c94b..b42e9571b0a 100644 --- a/docs/dyn/run_v2.projects.locations.services.html +++ b/docs/dyn/run_v2.projects.locations.services.html @@ -199,7 +199,7 @@

Method Details

"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. "A String", ], - "baseImageUri": "A String", # Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update. + "baseImageUri": "A String", # Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. "buildInfo": { # Build information of the image. # Output only. The build info of the container image. "functionTarget": "A String", # Output only. Entry point of the function when the image is a Cloud Run function. "sourceLocation": "A String", # Output only. Source code location of the image. @@ -558,7 +558,7 @@

Method Details

"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. "A String", ], - "baseImageUri": "A String", # Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update. + "baseImageUri": "A String", # Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. "buildInfo": { # Build information of the image. # Output only. The build info of the container image. "functionTarget": "A String", # Output only. Entry point of the function when the image is a Cloud Run function. "sourceLocation": "A String", # Output only. Source code location of the image. @@ -904,7 +904,7 @@

Method Details

"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. "A String", ], - "baseImageUri": "A String", # Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update. + "baseImageUri": "A String", # Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. "buildInfo": { # Build information of the image. # Output only. The build info of the container image. "functionTarget": "A String", # Output only. Entry point of the function when the image is a Cloud Run function. "sourceLocation": "A String", # Output only. Source code location of the image. @@ -1207,7 +1207,7 @@

Method Details

"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. "A String", ], - "baseImageUri": "A String", # Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update. + "baseImageUri": "A String", # Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. "buildInfo": { # Build information of the image. # Output only. The build info of the container image. "functionTarget": "A String", # Output only. Entry point of the function when the image is a Cloud Run function. "sourceLocation": "A String", # Output only. Source code location of the image. diff --git a/docs/dyn/run_v2.projects.locations.services.revisions.html b/docs/dyn/run_v2.projects.locations.services.revisions.html index fca9bd0080d..a29f8d6aa74 100644 --- a/docs/dyn/run_v2.projects.locations.services.revisions.html +++ b/docs/dyn/run_v2.projects.locations.services.revisions.html @@ -206,7 +206,7 @@

Method Details

"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. "A String", ], - "baseImageUri": "A String", # Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update. + "baseImageUri": "A String", # Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. "buildInfo": { # Build information of the image. # Output only. The build info of the container image. "functionTarget": "A String", # Output only. Entry point of the function when the image is a Cloud Run function. "sourceLocation": "A String", # Output only. Source code location of the image. @@ -431,7 +431,7 @@

Method Details

"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. "A String", ], - "baseImageUri": "A String", # Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update. + "baseImageUri": "A String", # Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. "buildInfo": { # Build information of the image. # Output only. The build info of the container image. "functionTarget": "A String", # Output only. Entry point of the function when the image is a Cloud Run function. "sourceLocation": "A String", # Output only. Source code location of the image. diff --git a/docs/dyn/run_v2.projects.locations.workerPools.revisions.html b/docs/dyn/run_v2.projects.locations.workerPools.revisions.html index 6aa15bb8405..08dc38b15f5 100644 --- a/docs/dyn/run_v2.projects.locations.workerPools.revisions.html +++ b/docs/dyn/run_v2.projects.locations.workerPools.revisions.html @@ -167,7 +167,7 @@

Method Details

"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. "A String", ], - "baseImageUri": "A String", # Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update. + "baseImageUri": "A String", # Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. "buildInfo": { # Build information of the image. # Output only. The build info of the container image. "functionTarget": "A String", # Output only. Entry point of the function when the image is a Cloud Run function. "sourceLocation": "A String", # Output only. Source code location of the image. @@ -392,7 +392,7 @@

Method Details

"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. "A String", ], - "baseImageUri": "A String", # Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update. + "baseImageUri": "A String", # Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. "buildInfo": { # Build information of the image. # Output only. The build info of the container image. "functionTarget": "A String", # Output only. Entry point of the function when the image is a Cloud Run function. "sourceLocation": "A String", # Output only. Source code location of the image. diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index b0501aac32a..426a084c6f3 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -2614,7 +2614,7 @@ } } }, -"revision": "20250117", +"revision": "20250131", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -3912,6 +3912,10 @@ false "$ref": "GoogleDevtoolsCloudbuildV1PoolOption", "description": "Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information." }, +"pubsubTopic": { +"description": "Optional. Option to specify the Pub/Sub topic to receive build status updates.", +"type": "string" +}, "requestedVerifyOption": { "description": "Requested verifiability options.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index 63169933316..a00994238af 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -1635,7 +1635,7 @@ } } }, -"revision": "20250124", +"revision": "20250131", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -1950,7 +1950,7 @@ "type": "array" }, "baseImageUri": { -"description": "Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update.", +"description": "Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update.", "type": "string" }, "buildInfo": { @@ -4655,6 +4655,10 @@ false "$ref": "GoogleDevtoolsCloudbuildV1PoolOption", "description": "Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information." }, +"pubsubTopic": { +"description": "Optional. Option to specify the Pub/Sub topic to receive build status updates.", +"type": "string" +}, "requestedVerifyOption": { "description": "Requested verifiability options.", "enum": [ From 8703bdef48376d82bdbc4c0c0f20e8292f84f074 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:10 +0000 Subject: [PATCH 22/31] fix(secretmanager): update the api #### secretmanager:v1 The following keys were changed: - endpoints (Total Keys: 1) #### secretmanager:v1beta1 The following keys were changed: - endpoints (Total Keys: 1) #### secretmanager:v1beta2 The following keys were changed: - endpoints (Total Keys: 1) --- .../discovery_cache/documents/secretmanager.v1.json | 7 ++++++- .../discovery_cache/documents/secretmanager.v1beta1.json | 7 ++++++- .../discovery_cache/documents/secretmanager.v1beta2.json | 7 ++++++- 3 files changed, 18 insertions(+), 3 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1.json index f9e40c0f09c..c9df9e699e8 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1.json @@ -110,6 +110,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-east7.rep.googleapis.com/", "location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.europe-north2.rep.googleapis.com/", +"location": "europe-north2" } ], "fullyEncodeReservedExpansion": true, @@ -1205,7 +1210,7 @@ } } }, -"revision": "20250117", +"revision": "20250130", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json index db44e716c76..b0e0f9a157e 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json @@ -110,6 +110,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-east7.rep.googleapis.com/", "location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.europe-north2.rep.googleapis.com/", +"location": "europe-north2" } ], "fullyEncodeReservedExpansion": true, @@ -725,7 +730,7 @@ } } }, -"revision": "20250117", +"revision": "20250130", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json b/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json index 2560c597d21..11bc526a2d7 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json @@ -110,6 +110,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-east7.rep.googleapis.com/", "location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.europe-north2.rep.googleapis.com/", +"location": "europe-north2" } ], "fullyEncodeReservedExpansion": true, @@ -1205,7 +1210,7 @@ } } }, -"revision": "20250117", +"revision": "20250130", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { From 6a0da678cbc57b9776779f193d02aaede96a07b5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:10 +0000 Subject: [PATCH 23/31] feat(serviceconsumermanagement): update the api #### serviceconsumermanagement:v1 The following keys were added: - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.type (Total Keys: 1) #### serviceconsumermanagement:v1beta1 The following keys were added: - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.type (Total Keys: 1) --- .../documents/serviceconsumermanagement.v1.json | 8 ++++++-- .../documents/serviceconsumermanagement.v1beta1.json | 8 ++++++-- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json index 93f1ff3852a..0b46f7a1689 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json @@ -542,7 +542,7 @@ } } }, -"revision": "20241210", +"revision": "20250130", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -2240,7 +2240,7 @@ "id": "Page", "properties": { "content": { -"description": "The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", +"description": "The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", "type": "string" }, "name": { @@ -2500,6 +2500,10 @@ "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", "id": "SelectiveGapicGeneration", "properties": { +"generateOmittedAsInternal": { +"description": "Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns.", +"type": "boolean" +}, "methods": { "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", "items": { diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json index 0addadbd3b4..ad8f54958ae 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json @@ -715,7 +715,7 @@ } } }, -"revision": "20241205", +"revision": "20250130", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -2289,7 +2289,7 @@ "id": "Page", "properties": { "content": { -"description": "The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", +"description": "The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", "type": "string" }, "name": { @@ -2502,6 +2502,10 @@ "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", "id": "SelectiveGapicGeneration", "properties": { +"generateOmittedAsInternal": { +"description": "Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns.", +"type": "boolean" +}, "methods": { "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", "items": { From 208baadc5daf1e92f7c08aaf507d950a5d8a3fde Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:10 +0000 Subject: [PATCH 24/31] feat(servicemanagement): update the api #### servicemanagement:v1 The following keys were added: - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.type (Total Keys: 1) - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.type (Total Keys: 1) --- ...servicemanagement_v1.services.configs.html | 52 ++++++++++++++++--- docs/dyn/servicemanagement_v1.services.html | 13 ++++- .../documents/servicemanagement.v1.json | 12 ++++- 3 files changed, 65 insertions(+), 12 deletions(-) diff --git a/docs/dyn/servicemanagement_v1.services.configs.html b/docs/dyn/servicemanagement_v1.services.configs.html index f695ff03117..aa58e0b99b3 100644 --- a/docs/dyn/servicemanagement_v1.services.configs.html +++ b/docs/dyn/servicemanagement_v1.services.configs.html @@ -264,7 +264,7 @@

Method Details

"overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. - "content": "A String", # The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. "subpages": [ # Subpages of this page. The order of subpages specified here will be honored in the generated docset. # Object with schema name: Page @@ -281,7 +281,7 @@

Method Details

], "sectionOverrides": [ # Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. - "content": "A String", # The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. "subpages": [ # Subpages of this page. The order of subpages specified here will be honored in the generated docset. # Object with schema name: Page @@ -471,6 +471,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -484,6 +485,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -512,6 +514,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -528,6 +531,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -546,6 +550,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -559,6 +564,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -572,6 +578,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -580,6 +587,7 @@

Method Details

"experimentalFeatures": { # Experimental features to be included during client library generation. These fields will be deprecated once the feature graduates and is enabled by default. # Experimental features to be included during client library generation. "protobufPythonicTypesEnabled": True or False, # Enables generation of protobuf code using new types that are more Pythonic which are included in `protobuf>=5.29.x`. This feature will be enabled by default 1 month after launching the feature in preview packages. "restAsyncIoEnabled": True or False, # Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages. + "unversionedPackageDisabled": True or False, # Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`. }, }, "restNumericEnums": True or False, # When using transport=rest, the client request will encode enums as numbers rather than strings. @@ -590,6 +598,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -930,7 +939,7 @@

Method Details

"overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. - "content": "A String", # The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. "subpages": [ # Subpages of this page. The order of subpages specified here will be honored in the generated docset. # Object with schema name: Page @@ -947,7 +956,7 @@

Method Details

], "sectionOverrides": [ # Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. - "content": "A String", # The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. "subpages": [ # Subpages of this page. The order of subpages specified here will be honored in the generated docset. # Object with schema name: Page @@ -1137,6 +1146,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -1150,6 +1160,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -1178,6 +1189,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -1194,6 +1206,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -1212,6 +1225,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -1225,6 +1239,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -1238,6 +1253,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -1246,6 +1262,7 @@

Method Details

"experimentalFeatures": { # Experimental features to be included during client library generation. These fields will be deprecated once the feature graduates and is enabled by default. # Experimental features to be included during client library generation. "protobufPythonicTypesEnabled": True or False, # Enables generation of protobuf code using new types that are more Pythonic which are included in `protobuf>=5.29.x`. This feature will be enabled by default 1 month after launching the feature in preview packages. "restAsyncIoEnabled": True or False, # Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages. + "unversionedPackageDisabled": True or False, # Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`. }, }, "restNumericEnums": True or False, # When using transport=rest, the client request will encode enums as numbers rather than strings. @@ -1256,6 +1273,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -1608,7 +1626,7 @@

Method Details

"overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. - "content": "A String", # The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. "subpages": [ # Subpages of this page. The order of subpages specified here will be honored in the generated docset. # Object with schema name: Page @@ -1625,7 +1643,7 @@

Method Details

], "sectionOverrides": [ # Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. - "content": "A String", # The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. "subpages": [ # Subpages of this page. The order of subpages specified here will be honored in the generated docset. # Object with schema name: Page @@ -1815,6 +1833,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -1828,6 +1847,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -1856,6 +1876,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -1872,6 +1893,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -1890,6 +1912,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -1903,6 +1926,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -1916,6 +1940,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -1924,6 +1949,7 @@

Method Details

"experimentalFeatures": { # Experimental features to be included during client library generation. These fields will be deprecated once the feature graduates and is enabled by default. # Experimental features to be included during client library generation. "protobufPythonicTypesEnabled": True or False, # Enables generation of protobuf code using new types that are more Pythonic which are included in `protobuf>=5.29.x`. This feature will be enabled by default 1 month after launching the feature in preview packages. "restAsyncIoEnabled": True or False, # Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages. + "unversionedPackageDisabled": True or False, # Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`. }, }, "restNumericEnums": True or False, # When using transport=rest, the client request will encode enums as numbers rather than strings. @@ -1934,6 +1960,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -2286,7 +2313,7 @@

Method Details

"overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. - "content": "A String", # The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. "subpages": [ # Subpages of this page. The order of subpages specified here will be honored in the generated docset. # Object with schema name: Page @@ -2303,7 +2330,7 @@

Method Details

], "sectionOverrides": [ # Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. - "content": "A String", # The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. "subpages": [ # Subpages of this page. The order of subpages specified here will be honored in the generated docset. # Object with schema name: Page @@ -2493,6 +2520,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -2506,6 +2534,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -2534,6 +2563,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -2550,6 +2580,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -2568,6 +2599,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -2581,6 +2613,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -2594,6 +2627,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -2602,6 +2636,7 @@

Method Details

"experimentalFeatures": { # Experimental features to be included during client library generation. These fields will be deprecated once the feature graduates and is enabled by default. # Experimental features to be included during client library generation. "protobufPythonicTypesEnabled": True or False, # Enables generation of protobuf code using new types that are more Pythonic which are included in `protobuf>=5.29.x`. This feature will be enabled by default 1 month after launching the feature in preview packages. "restAsyncIoEnabled": True or False, # Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages. + "unversionedPackageDisabled": True or False, # Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`. }, }, "restNumericEnums": True or False, # When using transport=rest, the client request will encode enums as numbers rather than strings. @@ -2612,6 +2647,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], diff --git a/docs/dyn/servicemanagement_v1.services.html b/docs/dyn/servicemanagement_v1.services.html index 2e2c9a434d4..19c8552dc2a 100644 --- a/docs/dyn/servicemanagement_v1.services.html +++ b/docs/dyn/servicemanagement_v1.services.html @@ -459,7 +459,7 @@

Method Details

"overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. - "content": "A String", # The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. "subpages": [ # Subpages of this page. The order of subpages specified here will be honored in the generated docset. # Object with schema name: Page @@ -476,7 +476,7 @@

Method Details

], "sectionOverrides": [ # Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. - "content": "A String", # The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. "subpages": [ # Subpages of this page. The order of subpages specified here will be honored in the generated docset. # Object with schema name: Page @@ -666,6 +666,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -679,6 +680,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -707,6 +709,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -723,6 +726,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -741,6 +745,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -754,6 +759,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -767,6 +773,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], @@ -775,6 +782,7 @@

Method Details

"experimentalFeatures": { # Experimental features to be included during client library generation. These fields will be deprecated once the feature graduates and is enabled by default. # Experimental features to be included during client library generation. "protobufPythonicTypesEnabled": True or False, # Enables generation of protobuf code using new types that are more Pythonic which are included in `protobuf>=5.29.x`. This feature will be enabled by default 1 month after launching the feature in preview packages. "restAsyncIoEnabled": True or False, # Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages. + "unversionedPackageDisabled": True or False, # Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`. }, }, "restNumericEnums": True or False, # When using transport=rest, the client request will encode enums as numbers rather than strings. @@ -785,6 +793,7 @@

Method Details

], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", ], diff --git a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json index dbaf50b889c..02e9fc2aea2 100644 --- a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json @@ -830,7 +830,7 @@ } } }, -"revision": "20241202", +"revision": "20250202", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { @@ -1794,6 +1794,10 @@ "restAsyncIoEnabled": { "description": "Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages.", "type": "boolean" +}, +"unversionedPackageDisabled": { +"description": "Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`.", +"type": "boolean" } }, "type": "object" @@ -2885,7 +2889,7 @@ "id": "Page", "properties": { "content": { -"description": "The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", +"description": "The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", "type": "string" }, "name": { @@ -3198,6 +3202,10 @@ "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", "id": "SelectiveGapicGeneration", "properties": { +"generateOmittedAsInternal": { +"description": "Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns.", +"type": "boolean" +}, "methods": { "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", "items": { From 578be921468cab9393a103e34773a6f5a40abc7b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:10 +0000 Subject: [PATCH 25/31] feat(servicenetworking): update the api #### servicenetworking:v1 The following keys were added: - schemas.Aspect (Total Keys: 5) - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.type (Total Keys: 1) - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.type (Total Keys: 1) - schemas.Service.properties.aspects (Total Keys: 2) #### servicenetworking:v1beta The following keys were added: - schemas.Aspect (Total Keys: 5) - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.type (Total Keys: 1) - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.type (Total Keys: 1) - schemas.Service.properties.aspects (Total Keys: 2) --- .../documents/servicenetworking.v1.json | 36 ++++++++++++++++++- .../documents/servicenetworking.v1beta.json | 36 ++++++++++++++++++- 2 files changed, 70 insertions(+), 2 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json index 6bc4e82e52a..d0223ce42ec 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json @@ -1029,7 +1029,7 @@ } } }, -"revision": "20250129", +"revision": "20250205", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1287,6 +1287,25 @@ }, "type": "object" }, +"Aspect": { +"description": "Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto", +"id": "Aspect", +"properties": { +"kind": { +"description": "The type of this aspect configuration.", +"type": "string" +}, +"spec": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.", +"type": "object" +} +}, +"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", @@ -2205,6 +2224,10 @@ "restAsyncIoEnabled": { "description": "Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages.", "type": "boolean" +}, +"unversionedPackageDisabled": { +"description": "Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`.", +"type": "boolean" } }, "type": "object" @@ -3646,6 +3669,10 @@ "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", "id": "SelectiveGapicGeneration", "properties": { +"generateOmittedAsInternal": { +"description": "Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns.", +"type": "boolean" +}, "methods": { "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", "items": { @@ -3667,6 +3694,13 @@ }, "type": "array" }, +"aspects": { +"description": "Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners.", +"items": { +"$ref": "Aspect" +}, +"type": "array" +}, "authentication": { "$ref": "Authentication", "description": "Auth configuration." diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json index 36e8e5ef715..9be21757984 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json @@ -307,7 +307,7 @@ } } }, -"revision": "20250129", +"revision": "20250205", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -454,6 +454,25 @@ }, "type": "object" }, +"Aspect": { +"description": "Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto", +"id": "Aspect", +"properties": { +"kind": { +"description": "The type of this aspect configuration.", +"type": "string" +}, +"spec": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.", +"type": "object" +} +}, +"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", @@ -1300,6 +1319,10 @@ "restAsyncIoEnabled": { "description": "Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages.", "type": "boolean" +}, +"unversionedPackageDisabled": { +"description": "Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`.", +"type": "boolean" } }, "type": "object" @@ -2575,6 +2598,10 @@ "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", "id": "SelectiveGapicGeneration", "properties": { +"generateOmittedAsInternal": { +"description": "Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns.", +"type": "boolean" +}, "methods": { "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", "items": { @@ -2596,6 +2623,13 @@ }, "type": "array" }, +"aspects": { +"description": "Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners.", +"items": { +"$ref": "Aspect" +}, +"type": "array" +}, "authentication": { "$ref": "Authentication", "description": "Auth configuration." From 0b249321dcb756f85e54575ae081982612e3d62c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:10 +0000 Subject: [PATCH 26/31] feat(serviceusage): update the api #### serviceusage:v1 The following keys were added: - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.type (Total Keys: 1) #### serviceusage:v1beta1 The following keys were added: - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.type (Total Keys: 1) --- docs/dyn/serviceusage_v1.services.html | 12 ++++++------ docs/dyn/serviceusage_v1beta1.services.html | 8 ++++---- .../discovery_cache/documents/serviceusage.v1.json | 8 ++++++-- .../documents/serviceusage.v1beta1.json | 8 ++++++-- 4 files changed, 22 insertions(+), 14 deletions(-) diff --git a/docs/dyn/serviceusage_v1.services.html b/docs/dyn/serviceusage_v1.services.html index de0d82c75b4..814a72a077a 100644 --- a/docs/dyn/serviceusage_v1.services.html +++ b/docs/dyn/serviceusage_v1.services.html @@ -244,7 +244,7 @@

Method Details

"overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. - "content": "A String", # The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. "subpages": [ # Subpages of this page. The order of subpages specified here will be honored in the generated docset. # Object with schema name: Page @@ -261,7 +261,7 @@

Method Details

], "sectionOverrides": [ # Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. - "content": "A String", # The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. "subpages": [ # Subpages of this page. The order of subpages specified here will be honored in the generated docset. # Object with schema name: Page @@ -552,7 +552,7 @@

Method Details

"overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. - "content": "A String", # The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. "subpages": [ # Subpages of this page. The order of subpages specified here will be honored in the generated docset. # Object with schema name: Page @@ -569,7 +569,7 @@

Method Details

], "sectionOverrides": [ # Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. - "content": "A String", # The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. "subpages": [ # Subpages of this page. The order of subpages specified here will be honored in the generated docset. # Object with schema name: Page @@ -775,7 +775,7 @@

Method Details

"overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. - "content": "A String", # The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. "subpages": [ # Subpages of this page. The order of subpages specified here will be honored in the generated docset. # Object with schema name: Page @@ -792,7 +792,7 @@

Method Details

], "sectionOverrides": [ # Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. - "content": "A String", # The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. "subpages": [ # Subpages of this page. The order of subpages specified here will be honored in the generated docset. # Object with schema name: Page diff --git a/docs/dyn/serviceusage_v1beta1.services.html b/docs/dyn/serviceusage_v1beta1.services.html index afa30dd1903..c2772afff69 100644 --- a/docs/dyn/serviceusage_v1beta1.services.html +++ b/docs/dyn/serviceusage_v1beta1.services.html @@ -368,7 +368,7 @@

Method Details

"overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. - "content": "A String", # The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. "subpages": [ # Subpages of this page. The order of subpages specified here will be honored in the generated docset. # Object with schema name: Page @@ -385,7 +385,7 @@

Method Details

], "sectionOverrides": [ # Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. - "content": "A String", # The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. "subpages": [ # Subpages of this page. The order of subpages specified here will be honored in the generated docset. # Object with schema name: Page @@ -591,7 +591,7 @@

Method Details

"overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. - "content": "A String", # The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. "subpages": [ # Subpages of this page. The order of subpages specified here will be honored in the generated docset. # Object with schema name: Page @@ -608,7 +608,7 @@

Method Details

], "sectionOverrides": [ # Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries { # Represents a documentation page. A page can contain subpages to represent nested documentation set structure. - "content": "A String", # The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + "content": "A String", # The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. "name": "A String", # The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. "subpages": [ # Subpages of this page. The order of subpages specified here will be honored in the generated docset. # Object with schema name: Page diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1.json index e3542b81060..f41a344d942 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1.json @@ -426,7 +426,7 @@ } } }, -"revision": "20241219", +"revision": "20250130", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -3065,7 +3065,7 @@ "id": "Page", "properties": { "content": { -"description": "The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", +"description": "The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", "type": "string" }, "name": { @@ -3338,6 +3338,10 @@ "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", "id": "SelectiveGapicGeneration", "properties": { +"generateOmittedAsInternal": { +"description": "Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns.", +"type": "boolean" +}, "methods": { "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", "items": { diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json index 3b1d4d97c98..e9772f52f47 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json @@ -964,7 +964,7 @@ } } }, -"revision": "20241219", +"revision": "20250130", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -3774,7 +3774,7 @@ "id": "Page", "properties": { "content": { -"description": "The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", +"description": "The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", "type": "string" }, "name": { @@ -4137,6 +4137,10 @@ "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", "id": "SelectiveGapicGeneration", "properties": { +"generateOmittedAsInternal": { +"description": "Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns.", +"type": "boolean" +}, "methods": { "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", "items": { From 84983cc040488c933c189ed82a886189c70e445f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:10 +0000 Subject: [PATCH 27/31] feat(spanner): update the api #### spanner:v1 The following keys were added: - schemas.Backup.properties.instancePartitions (Total Keys: 3) - schemas.BackupInstancePartition (Total Keys: 3) --- ...spanner_v1.projects.instances.backups.html | 25 ++++++++ ...s.instances.databases.backupSchedules.html | 60 +++++++++---------- .../discovery_cache/documents/spanner.v1.json | 31 ++++++++-- 3 files changed, 80 insertions(+), 36 deletions(-) diff --git a/docs/dyn/spanner_v1.projects.instances.backups.html b/docs/dyn/spanner_v1.projects.instances.backups.html index 0f54f1d738f..72e40643d85 100644 --- a/docs/dyn/spanner_v1.projects.instances.backups.html +++ b/docs/dyn/spanner_v1.projects.instances.backups.html @@ -217,6 +217,11 @@

Method Details

"expireTime": "A String", # Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. "freeableSizeBytes": "A String", # Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired. "incrementalBackupChainId": "A String", # Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup `version_time`. + "instancePartitions": [ # Output only. The instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup's `version_time`. + { # Instance partition information for the backup. + "instancePartition": "A String", # A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/` + }, + ], "maxExpireTime": "A String", # Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`. "name": "A String", # Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`. "oldestVersionTime": "A String", # Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system. @@ -340,6 +345,11 @@

Method Details

"expireTime": "A String", # Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. "freeableSizeBytes": "A String", # Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired. "incrementalBackupChainId": "A String", # Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup `version_time`. + "instancePartitions": [ # Output only. The instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup's `version_time`. + { # Instance partition information for the backup. + "instancePartition": "A String", # A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/` + }, + ], "maxExpireTime": "A String", # Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`. "name": "A String", # Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`. "oldestVersionTime": "A String", # Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system. @@ -456,6 +466,11 @@

Method Details

"expireTime": "A String", # Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. "freeableSizeBytes": "A String", # Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired. "incrementalBackupChainId": "A String", # Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup `version_time`. + "instancePartitions": [ # Output only. The instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup's `version_time`. + { # Instance partition information for the backup. + "instancePartition": "A String", # A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/` + }, + ], "maxExpireTime": "A String", # Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`. "name": "A String", # Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`. "oldestVersionTime": "A String", # Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system. @@ -536,6 +551,11 @@

Method Details

"expireTime": "A String", # Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. "freeableSizeBytes": "A String", # Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired. "incrementalBackupChainId": "A String", # Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup `version_time`. + "instancePartitions": [ # Output only. The instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup's `version_time`. + { # Instance partition information for the backup. + "instancePartition": "A String", # A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/` + }, + ], "maxExpireTime": "A String", # Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`. "name": "A String", # Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`. "oldestVersionTime": "A String", # Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system. @@ -598,6 +618,11 @@

Method Details

"expireTime": "A String", # Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. "freeableSizeBytes": "A String", # Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired. "incrementalBackupChainId": "A String", # Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup `version_time`. + "instancePartitions": [ # Output only. The instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup's `version_time`. + { # Instance partition information for the backup. + "instancePartition": "A String", # A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/` + }, + ], "maxExpireTime": "A String", # Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`. "name": "A String", # Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`. "oldestVersionTime": "A String", # Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system. diff --git a/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html b/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html index 0126b1a3721..45ca038352e 100644 --- a/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html +++ b/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html @@ -120,7 +120,7 @@

Method Details

The object takes the form of: { # BackupSchedule expresses the automated backup creation specification for a Spanner database. - "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database. + "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that is used to encrypt the backup. If this field is not specified, the backup uses the same encryption configuration as the database. "encryptionType": "A String", # Required. The encryption type of the backup. "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. @@ -134,10 +134,10 @@

Method Details

"name": "A String", # Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. "retentionDuration": "A String", # Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed. "spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered. - "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification. - "creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`. - "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2,14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC. - "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported. + "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup is created. # Cron style schedule specification. + "creationWindow": "A String", # Output only. Scheduled backups contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner might not initiate the creation of the scheduled backups at that version time. Spanner initiates the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`. + "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC. + "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently, only UTC is supported. }, }, "updateTime": "A String", # Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created. @@ -153,7 +153,7 @@

Method Details

An object of the form: { # BackupSchedule expresses the automated backup creation specification for a Spanner database. - "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database. + "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that is used to encrypt the backup. If this field is not specified, the backup uses the same encryption configuration as the database. "encryptionType": "A String", # Required. The encryption type of the backup. "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. @@ -167,10 +167,10 @@

Method Details

"name": "A String", # Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. "retentionDuration": "A String", # Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed. "spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered. - "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification. - "creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`. - "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2,14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC. - "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported. + "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup is created. # Cron style schedule specification. + "creationWindow": "A String", # Output only. Scheduled backups contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner might not initiate the creation of the scheduled backups at that version time. Spanner initiates the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`. + "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC. + "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently, only UTC is supported. }, }, "updateTime": "A String", # Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created. @@ -210,7 +210,7 @@

Method Details

An object of the form: { # BackupSchedule expresses the automated backup creation specification for a Spanner database. - "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database. + "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that is used to encrypt the backup. If this field is not specified, the backup uses the same encryption configuration as the database. "encryptionType": "A String", # Required. The encryption type of the backup. "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. @@ -224,10 +224,10 @@

Method Details

"name": "A String", # Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. "retentionDuration": "A String", # Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed. "spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered. - "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification. - "creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`. - "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2,14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC. - "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported. + "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup is created. # Cron style schedule specification. + "creationWindow": "A String", # Output only. Scheduled backups contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner might not initiate the creation of the scheduled backups at that version time. Spanner initiates the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`. + "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC. + "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently, only UTC is supported. }, }, "updateTime": "A String", # Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created. @@ -296,7 +296,7 @@

Method Details

{ # The response for ListBackupSchedules. "backupSchedules": [ # The list of backup schedules for a database. { # BackupSchedule expresses the automated backup creation specification for a Spanner database. - "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database. + "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that is used to encrypt the backup. If this field is not specified, the backup uses the same encryption configuration as the database. "encryptionType": "A String", # Required. The encryption type of the backup. "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. @@ -310,10 +310,10 @@

Method Details

"name": "A String", # Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. "retentionDuration": "A String", # Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed. "spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered. - "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification. - "creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`. - "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2,14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC. - "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported. + "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup is created. # Cron style schedule specification. + "creationWindow": "A String", # Output only. Scheduled backups contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner might not initiate the creation of the scheduled backups at that version time. Spanner initiates the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`. + "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC. + "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently, only UTC is supported. }, }, "updateTime": "A String", # Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created. @@ -347,7 +347,7 @@

Method Details

The object takes the form of: { # BackupSchedule expresses the automated backup creation specification for a Spanner database. - "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database. + "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that is used to encrypt the backup. If this field is not specified, the backup uses the same encryption configuration as the database. "encryptionType": "A String", # Required. The encryption type of the backup. "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. @@ -361,10 +361,10 @@

Method Details

"name": "A String", # Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. "retentionDuration": "A String", # Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed. "spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered. - "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification. - "creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`. - "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2,14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC. - "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported. + "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup is created. # Cron style schedule specification. + "creationWindow": "A String", # Output only. Scheduled backups contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner might not initiate the creation of the scheduled backups at that version time. Spanner initiates the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`. + "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC. + "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently, only UTC is supported. }, }, "updateTime": "A String", # Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created. @@ -380,7 +380,7 @@

Method Details

An object of the form: { # BackupSchedule expresses the automated backup creation specification for a Spanner database. - "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database. + "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that is used to encrypt the backup. If this field is not specified, the backup uses the same encryption configuration as the database. "encryptionType": "A String", # Required. The encryption type of the backup. "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. @@ -394,10 +394,10 @@

Method Details

"name": "A String", # Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. "retentionDuration": "A String", # Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed. "spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered. - "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification. - "creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`. - "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2,14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC. - "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported. + "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup is created. # Cron style schedule specification. + "creationWindow": "A String", # Output only. Scheduled backups contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner might not initiate the creation of the scheduled backups at that version time. Spanner initiates the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`. + "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC. + "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently, only UTC is supported. }, }, "updateTime": "A String", # Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created. diff --git a/googleapiclient/discovery_cache/documents/spanner.v1.json b/googleapiclient/discovery_cache/documents/spanner.v1.json index bdc93005bd8..ab62a75ebe7 100644 --- a/googleapiclient/discovery_cache/documents/spanner.v1.json +++ b/googleapiclient/discovery_cache/documents/spanner.v1.json @@ -3348,7 +3348,7 @@ } } }, -"revision": "20250123", +"revision": "20250201", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "AddSplitPointsRequest": { @@ -3544,6 +3544,14 @@ "readOnly": true, "type": "string" }, +"instancePartitions": { +"description": "Output only. The instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup's `version_time`.", +"items": { +"$ref": "BackupInstancePartition" +}, +"readOnly": true, +"type": "array" +}, "maxExpireTime": { "description": "Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`.", "format": "google-datetime", @@ -3630,13 +3638,24 @@ }, "type": "object" }, +"BackupInstancePartition": { +"description": "Instance partition information for the backup.", +"id": "BackupInstancePartition", +"properties": { +"instancePartition": { +"description": "A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/`", +"type": "string" +} +}, +"type": "object" +}, "BackupSchedule": { "description": "BackupSchedule expresses the automated backup creation specification for a Spanner database.", "id": "BackupSchedule", "properties": { "encryptionConfig": { "$ref": "CreateBackupEncryptionConfig", -"description": "Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database." +"description": "Optional. The encryption configuration that is used to encrypt the backup. If this field is not specified, the backup uses the same encryption configuration as the database." }, "fullBackupSpec": { "$ref": "FullBackupSpec", @@ -4305,21 +4324,21 @@ "type": "object" }, "CrontabSpec": { -"description": "CrontabSpec can be used to specify the version time and frequency at which the backup should be created.", +"description": "CrontabSpec can be used to specify the version time and frequency at which the backup is created.", "id": "CrontabSpec", "properties": { "creationWindow": { -"description": "Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.", +"description": "Output only. Scheduled backups contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner might not initiate the creation of the scheduled backups at that version time. Spanner initiates the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.", "format": "google-duration", "readOnly": true, "type": "string" }, "text": { -"description": "Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2,14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC.", +"description": "Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC.", "type": "string" }, "timeZone": { -"description": "Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.", +"description": "Output only. The time zone of the times in `CrontabSpec.text`. Currently, only UTC is supported.", "readOnly": true, "type": "string" } From b70619d265c280c85d5b09440b226567b82b59e9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:10 +0000 Subject: [PATCH 28/31] feat(toolresults): update the api #### toolresults:v1beta3 The following keys were added: - schemas.NonSdkApi.properties.list.deprecated (Total Keys: 1) --- .../discovery_cache/documents/toolresults.v1beta3.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json b/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json index 0a2ac4da489..f74a1e708cb 100644 --- a/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json @@ -1464,7 +1464,7 @@ } } }, -"revision": "20241121", +"revision": "20250204", "rootUrl": "https://toolresults.googleapis.com/", "schemas": { "ANR": { @@ -2635,6 +2635,7 @@ "type": "integer" }, "list": { +"deprecated": true, "description": "Which list this API appears on", "enum": [ "NONE", From 238128272d79e7ee7a08bd0026fc68fe1a584fae Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:11 +0000 Subject: [PATCH 29/31] feat(vault): update the api #### vault:v1 The following keys were added: - schemas.ExportOptions.properties.geminiOptions.$ref (Total Keys: 1) - schemas.GeminiExportOptions (Total Keys: 3) - schemas.GeminiOptions (Total Keys: 2) - schemas.Query.properties.geminiOptions.$ref (Total Keys: 1) --- docs/dyn/vault_v1.matters.exports.html | 20 +++++ docs/dyn/vault_v1.matters.html | 2 + docs/dyn/vault_v1.matters.savedQueries.html | 8 ++ .../discovery_cache/documents/vault.v1.json | 83 +++++++++++++++---- 4 files changed, 98 insertions(+), 15 deletions(-) diff --git a/docs/dyn/vault_v1.matters.exports.html b/docs/dyn/vault_v1.matters.exports.html index e63be9dca9a..b6e712aec8f 100644 --- a/docs/dyn/vault_v1.matters.exports.html +++ b/docs/dyn/vault_v1.matters.exports.html @@ -126,6 +126,9 @@

Method Details

"driveOptions": { # Options for Drive exports. # Options for Drive exports. "includeAccessInfo": True or False, # To include access level information for users with [indirect access](https://support.google.com/vault/answer/6099459#metadata) to files, set to **true**. }, + "geminiOptions": { # The options for Gemini exports. # Option available for Gemini export. + "exportFormat": "A String", # The file format for exported messages. + }, "groupsOptions": { # Options for Groups exports. # Options for Groups exports. "exportFormat": "A String", # The file format for exported messages. }, @@ -177,6 +180,8 @@

Method Details

"versionDate": "A String", # Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC. }, "endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. + "geminiOptions": { # Additional options for Gemini search # Set Gemini search-specific options. + }, "hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only) "roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/chat). There is a limit of exporting from 500 Chat spaces per request. "A String", @@ -257,6 +262,9 @@

Method Details

"driveOptions": { # Options for Drive exports. # Options for Drive exports. "includeAccessInfo": True or False, # To include access level information for users with [indirect access](https://support.google.com/vault/answer/6099459#metadata) to files, set to **true**. }, + "geminiOptions": { # The options for Gemini exports. # Option available for Gemini export. + "exportFormat": "A String", # The file format for exported messages. + }, "groupsOptions": { # Options for Groups exports. # Options for Groups exports. "exportFormat": "A String", # The file format for exported messages. }, @@ -308,6 +316,8 @@

Method Details

"versionDate": "A String", # Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC. }, "endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. + "geminiOptions": { # Additional options for Gemini search # Set Gemini search-specific options. + }, "hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only) "roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/chat). There is a limit of exporting from 500 Chat spaces per request. "A String", @@ -415,6 +425,9 @@

Method Details

"driveOptions": { # Options for Drive exports. # Options for Drive exports. "includeAccessInfo": True or False, # To include access level information for users with [indirect access](https://support.google.com/vault/answer/6099459#metadata) to files, set to **true**. }, + "geminiOptions": { # The options for Gemini exports. # Option available for Gemini export. + "exportFormat": "A String", # The file format for exported messages. + }, "groupsOptions": { # Options for Groups exports. # Options for Groups exports. "exportFormat": "A String", # The file format for exported messages. }, @@ -466,6 +479,8 @@

Method Details

"versionDate": "A String", # Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC. }, "endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. + "geminiOptions": { # Additional options for Gemini search # Set Gemini search-specific options. + }, "hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only) "roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/chat). There is a limit of exporting from 500 Chat spaces per request. "A String", @@ -557,6 +572,9 @@

Method Details

"driveOptions": { # Options for Drive exports. # Options for Drive exports. "includeAccessInfo": True or False, # To include access level information for users with [indirect access](https://support.google.com/vault/answer/6099459#metadata) to files, set to **true**. }, + "geminiOptions": { # The options for Gemini exports. # Option available for Gemini export. + "exportFormat": "A String", # The file format for exported messages. + }, "groupsOptions": { # Options for Groups exports. # Options for Groups exports. "exportFormat": "A String", # The file format for exported messages. }, @@ -608,6 +626,8 @@

Method Details

"versionDate": "A String", # Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC. }, "endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. + "geminiOptions": { # Additional options for Gemini search # Set Gemini search-specific options. + }, "hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only) "roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/chat). There is a limit of exporting from 500 Chat spaces per request. "A String", diff --git a/docs/dyn/vault_v1.matters.html b/docs/dyn/vault_v1.matters.html index e67f381c90d..4780c428cc1 100644 --- a/docs/dyn/vault_v1.matters.html +++ b/docs/dyn/vault_v1.matters.html @@ -235,6 +235,8 @@

Method Details

"versionDate": "A String", # Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC. }, "endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. + "geminiOptions": { # Additional options for Gemini search # Set Gemini search-specific options. + }, "hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only) "roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/chat). There is a limit of exporting from 500 Chat spaces per request. "A String", diff --git a/docs/dyn/vault_v1.matters.savedQueries.html b/docs/dyn/vault_v1.matters.savedQueries.html index dcfbfa55921..e1e3d7a2309 100644 --- a/docs/dyn/vault_v1.matters.savedQueries.html +++ b/docs/dyn/vault_v1.matters.savedQueries.html @@ -141,6 +141,8 @@

Method Details

"versionDate": "A String", # Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC. }, "endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. + "geminiOptions": { # Additional options for Gemini search # Set Gemini search-specific options. + }, "hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only) "roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/chat). There is a limit of exporting from 500 Chat spaces per request. "A String", @@ -227,6 +229,8 @@

Method Details

"versionDate": "A String", # Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC. }, "endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. + "geminiOptions": { # Additional options for Gemini search # Set Gemini search-specific options. + }, "hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only) "roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/chat). There is a limit of exporting from 500 Chat spaces per request. "A String", @@ -340,6 +344,8 @@

Method Details

"versionDate": "A String", # Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC. }, "endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. + "geminiOptions": { # Additional options for Gemini search # Set Gemini search-specific options. + }, "hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only) "roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/chat). There is a limit of exporting from 500 Chat spaces per request. "A String", @@ -438,6 +444,8 @@

Method Details

"versionDate": "A String", # Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC. }, "endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. + "geminiOptions": { # Additional options for Gemini search # Set Gemini search-specific options. + }, "hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only) "roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/chat). There is a limit of exporting from 500 Chat spaces per request. "A String", diff --git a/googleapiclient/discovery_cache/documents/vault.v1.json b/googleapiclient/discovery_cache/documents/vault.v1.json index 2ac7b55dc32..86f135177d7 100644 --- a/googleapiclient/discovery_cache/documents/vault.v1.json +++ b/googleapiclient/discovery_cache/documents/vault.v1.json @@ -1203,7 +1203,7 @@ } } }, -"revision": "20250124", +"revision": "20250130", "rootUrl": "https://vault.googleapis.com/", "schemas": { "AccountCount": { @@ -1346,13 +1346,15 @@ "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", -"ICS" +"ICS", +"XML" ], "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", -"Export as ICS. Only available for Calendar." +"Export as ICS. Only available for Calendar.", +"Export as XML. Only available for Gemini." ], "type": "string" } @@ -1707,6 +1709,10 @@ "$ref": "DriveExportOptions", "description": "Options for Drive exports." }, +"geminiOptions": { +"$ref": "GeminiExportOptions", +"description": "Option available for Gemini export." +}, "groupsOptions": { "$ref": "GroupsExportOptions", "description": "Options for Groups exports." @@ -1764,6 +1770,37 @@ }, "type": "object" }, +"GeminiExportOptions": { +"description": "The options for Gemini exports.", +"id": "GeminiExportOptions", +"properties": { +"exportFormat": { +"description": "The file format for exported messages.", +"enum": [ +"EXPORT_FORMAT_UNSPECIFIED", +"MBOX", +"PST", +"ICS", +"XML" +], +"enumDescriptions": [ +"No export format specified.", +"Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", +"Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", +"Export as ICS. Only available for Calendar.", +"Export as XML. Only available for Gemini." +], +"type": "string" +} +}, +"type": "object" +}, +"GeminiOptions": { +"description": "Additional options for Gemini search", +"id": "GeminiOptions", +"properties": {}, +"type": "object" +}, "GroupsCountResult": { "description": "Groups specific count metrics.", "id": "GroupsCountResult", @@ -1812,13 +1849,15 @@ "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", -"ICS" +"ICS", +"XML" ], "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", -"Export as ICS. Only available for Calendar." +"Export as ICS. Only available for Calendar.", +"Export as XML. Only available for Gemini." ], "type": "string" } @@ -1835,13 +1874,15 @@ "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", -"ICS" +"ICS", +"XML" ], "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", -"Export as ICS. Only available for Calendar." +"Export as ICS. Only available for Calendar.", +"Export as XML. Only available for Gemini." ], "type": "string" } @@ -2038,7 +2079,8 @@ "GROUPS", "HANGOUTS_CHAT", "VOICE", -"CALENDAR" +"CALENDAR", +"GEMINI" ], "enumDescriptions": [ "No service specified.", @@ -2047,7 +2089,8 @@ "Groups.", "For export, Google Chat only. For holds, Google Chat and classic Hangouts.", "Google Voice.", -"Calendar." +"Calendar.", +"Gemini." ], "type": "string" }, @@ -2227,13 +2270,15 @@ "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", -"ICS" +"ICS", +"XML" ], "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", -"Export as ICS. Only available for Calendar." +"Export as ICS. Only available for Calendar.", +"Export as XML. Only available for Gemini." ], "type": "string" }, @@ -2429,7 +2474,8 @@ "GROUPS", "HANGOUTS_CHAT", "VOICE", -"CALENDAR" +"CALENDAR", +"GEMINI" ], "enumDescriptions": [ "No service specified.", @@ -2438,7 +2484,8 @@ "Groups.", "For export, Google Chat only. For holds, Google Chat and classic Hangouts.", "Google Voice.", -"Calendar." +"Calendar.", +"Gemini." ], "type": "string" }, @@ -2467,6 +2514,10 @@ "format": "google-datetime", "type": "string" }, +"geminiOptions": { +"$ref": "GeminiOptions", +"description": "Set Gemini search-specific options." +}, "hangoutsChatInfo": { "$ref": "HangoutsChatInfo", "description": "Required when **SearchMethod** is **ROOM**. (read-only)" @@ -2771,13 +2822,15 @@ false "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", -"ICS" +"ICS", +"XML" ], "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", -"Export as ICS. Only available for Calendar." +"Export as ICS. Only available for Calendar.", +"Export as XML. Only available for Gemini." ], "type": "string" } From 7b14bd275cda61093739b919db4c9995fe857c87 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:11 +0000 Subject: [PATCH 30/31] feat(walletobjects): update the api #### walletobjects:v1 The following keys were added: - resources.walletobjects.resources.v1.resources.privateContent.methods.setPassUpdateNotice (Total Keys: 8) - schemas.SetPassUpdateNoticeRequest (Total Keys: 5) - schemas.SetPassUpdateNoticeResponse (Total Keys: 2) --- docs/dyn/walletobjects_v1.html | 5 ++ ...ts_v1.walletobjects.v1.privateContent.html | 67 +++---------------- .../documents/walletobjects.v1.json | 57 +++++++++++++++- 3 files changed, 70 insertions(+), 59 deletions(-) diff --git a/docs/dyn/walletobjects_v1.html b/docs/dyn/walletobjects_v1.html index 50efbdbdf33..7727edf93d2 100644 --- a/docs/dyn/walletobjects_v1.html +++ b/docs/dyn/walletobjects_v1.html @@ -169,6 +169,11 @@

Instance Methods

Returns the transitobject Resource.

+

+ walletobjects() +

+

Returns the walletobjects Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/walletobjects_v1.walletobjects.v1.privateContent.html b/docs/dyn/walletobjects_v1.walletobjects.v1.privateContent.html index ee25b627ff2..713b6a4a7ba 100644 --- a/docs/dyn/walletobjects_v1.walletobjects.v1.privateContent.html +++ b/docs/dyn/walletobjects_v1.walletobjects.v1.privateContent.html @@ -78,8 +78,8 @@

Instance Methods

close()

Close httplib2 connections.

- uploadPrivateData(body=None, x__xgafv=None)

-

Upload private data (text or URI) and returns an Id to be used in its place.

+ setPassUpdateNotice(body=None, x__xgafv=None)

+

Provide Google with information about awaiting private pass update. This will allow Google to provide the update notification to the device that currently holds this pass.

Method Details

close() @@ -87,65 +87,17 @@

Method Details

- uploadPrivateData(body=None, x__xgafv=None) -
Upload private data (text or URI) and returns an Id to be used in its place.
+    setPassUpdateNotice(body=None, x__xgafv=None)
+  
Provide Google with information about awaiting private pass update. This will allow Google to provide the update notification to the device that currently holds this pass.
 
 Args:
   body: object, The request body.
     The object takes the form of:
 
-{ # Request for sending user private Text or URI by the Issuer.
-  "issuerId": "A String", # The ID of the issuer sending the data.
-  "text": { # Private data for TextModule. This data will be rendered as a TextModule for a pass. # Private text data of the user.
-    "body": { # Translated strings for the body.
-      "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
-        "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
-        "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-        "value": "A String", # The UTF-8 encoded translated string.
-      },
-      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
-      "translatedValues": [ # Contains the translations for the string.
-        {
-          "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
-          "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-          "value": "A String", # The UTF-8 encoded translated string.
-        },
-      ],
-    },
-    "header": { # Translated strings for the header.
-      "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
-        "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
-        "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-        "value": "A String", # The UTF-8 encoded translated string.
-      },
-      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
-      "translatedValues": [ # Contains the translations for the string.
-        {
-          "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
-          "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-          "value": "A String", # The UTF-8 encoded translated string.
-        },
-      ],
-    },
-  },
-  "uri": { # Private data for LinkModule. This data will be rendered as the LinkModule for a pass. # Private URIs of the user.
-    "description": { # The URI's title appearing in the app as text and its translated strings. Recommended maximum is 20 characters to ensure the full string is displayed on smaller screens.
-      "defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
-        "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
-        "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-        "value": "A String", # The UTF-8 encoded translated string.
-      },
-      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
-      "translatedValues": [ # Contains the translations for the string.
-        {
-          "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
-          "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-          "value": "A String", # The UTF-8 encoded translated string.
-        },
-      ],
-    },
-    "uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address).
-  },
+{ # Request to send a private pass update notice information to Google, so that devices can then fetch the notice prompting the user to update a pass.
+  "externalPassId": "A String", # Required. A fully qualified identifier of the pass that the issuer wants to notify the pass holder(s) about. Formatted as .
+  "updateUri": "A String", # Required. The issuer endpoint URI the pass holder needs to follow in order to receive an updated pass JWT. It can not contain any sensitive information. The endpoint needs to authenticate the user before giving the user the updated JWT. Example update URI https://someissuer.com/update/passId=someExternalPassId
+  "updatedPassJwtSignature": "A String", # Required. The JWT signature of the updated pass that the issuer wants to notify Google about. Only devices that report a different JWT signature than this JWT signature will receive the update notification.
 }
 
   x__xgafv: string, V1 error format.
@@ -156,8 +108,7 @@ 

Method Details

Returns: An object of the form: - { # Response for uploading user private data (text or URIs) - "privateContentId": "A String", # A 64-bit content id for the private data that was uploaded by the Issuer. + { # A response to a request to notify Google of an awaiting update to a private pass. }
diff --git a/googleapiclient/discovery_cache/documents/walletobjects.v1.json b/googleapiclient/discovery_cache/documents/walletobjects.v1.json index 0b3e55e5a8c..db1c3a9bcda 100644 --- a/googleapiclient/discovery_cache/documents/walletobjects.v1.json +++ b/googleapiclient/discovery_cache/documents/walletobjects.v1.json @@ -2679,9 +2679,39 @@ ] } } +}, +"walletobjects": { +"resources": { +"v1": { +"resources": { +"privateContent": { +"methods": { +"setPassUpdateNotice": { +"description": "Provide Google with information about awaiting private pass update. This will allow Google to provide the update notification to the device that currently holds this pass.", +"flatPath": "walletobjects/v1/privateContent/setPassUpdateNotice", +"httpMethod": "POST", +"id": "walletobjects.walletobjects.v1.privateContent.setPassUpdateNotice", +"parameterOrder": [], +"parameters": {}, +"path": "walletobjects/v1/privateContent/setPassUpdateNotice", +"request": { +"$ref": "SetPassUpdateNoticeRequest" +}, +"response": { +"$ref": "SetPassUpdateNoticeResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/wallet_object.issuer" +] +} +} +} +} +} +} } }, -"revision": "20241203", +"revision": "20250204", "rootUrl": "https://walletobjects.googleapis.com/", "schemas": { "ActivationOptions": { @@ -8572,6 +8602,31 @@ true }, "type": "object" }, +"SetPassUpdateNoticeRequest": { +"description": "Request to send a private pass update notice information to Google, so that devices can then fetch the notice prompting the user to update a pass.", +"id": "SetPassUpdateNoticeRequest", +"properties": { +"externalPassId": { +"description": "Required. A fully qualified identifier of the pass that the issuer wants to notify the pass holder(s) about. Formatted as .", +"type": "string" +}, +"updateUri": { +"description": "Required. The issuer endpoint URI the pass holder needs to follow in order to receive an updated pass JWT. It can not contain any sensitive information. The endpoint needs to authenticate the user before giving the user the updated JWT. Example update URI https://someissuer.com/update/passId=someExternalPassId", +"type": "string" +}, +"updatedPassJwtSignature": { +"description": "Required. The JWT signature of the updated pass that the issuer wants to notify Google about. Only devices that report a different JWT signature than this JWT signature will receive the update notification.", +"type": "string" +} +}, +"type": "object" +}, +"SetPassUpdateNoticeResponse": { +"description": "A response to a request to notify Google of an awaiting update to a private pass.", +"id": "SetPassUpdateNoticeResponse", +"properties": {}, +"type": "object" +}, "SignUpInfo": { "id": "SignUpInfo", "properties": { From 2186fc229585e02e4c22776f297ef9a2b47e7cc1 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 11 Feb 2025 07:09:11 +0000 Subject: [PATCH 31/31] chore(docs): Add new discovery artifacts and artifacts with minor updates --- ...rketplace_v1alpha.buyers.dataSegments.html | 16 +++++----- ...pdr_v1.projects.locations.backupPlans.html | 6 ++-- ...bleadmin_v2.projects.instances.tables.html | 2 +- ...tions_v2.projects.locations.functions.html | 2 +- ..._v2alpha.projects.locations.functions.html | 2 +- ...s_v2beta.projects.locations.functions.html | 2 +- ...ha1.projects.locations.contactCenters.html | 8 ++--- docs/dyn/datastore_v1.projects.html | 2 +- docs/dyn/datastore_v1beta3.projects.html | 2 +- .../file_v1.projects.locations.instances.html | 8 ++--- ..._v1beta1.projects.locations.instances.html | 8 ++--- ...appdistribution_v1alpha.projects.apps.html | 3 -- ..._v1alpha.projects.apps.releases.tests.html | 4 --- ...ution_v1alpha.projects.apps.testCases.html | 6 ---- .../merchantapi_accounts_v1beta.accounts.html | 4 +-- ...roducts_v1beta.accounts.productInputs.html | 2 +- ...projects.locations.vpcFlowLogsConfigs.html | 8 ++--- ...anizations.locations.securityProfiles.html | 32 +++++++++---------- ...g_v1alpha1.vitals.excessivewakeuprate.html | 2 +- ...ing_v1alpha1.vitals.slowrenderingrate.html | 2 +- ...porting_v1alpha1.vitals.slowstartrate.html | 2 +- ...a1.vitals.stuckbackgroundwakelockrate.html | 2 +- ...ng_v1beta1.vitals.excessivewakeuprate.html | 2 +- ...ting_v1beta1.vitals.slowrenderingrate.html | 2 +- ...eporting_v1beta1.vitals.slowstartrate.html | 2 +- ...a1.vitals.stuckbackgroundwakelockrate.html | 2 +- docs/dyn/realtimebidding_v1.bidders.html | 4 +-- ...rojects.locations.catalogs.placements.html | 2 +- ...cts.locations.catalogs.servingConfigs.html | 2 +- ...rojects.locations.catalogs.placements.html | 2 +- ...cts.locations.catalogs.servingConfigs.html | 2 +- ...rojects.locations.catalogs.placements.html | 2 +- ...cts.locations.catalogs.servingConfigs.html | 2 +- docs/dyn/script_v1.scripts.html | 4 +-- ...rations.projects.locations.operations.html | 4 +-- ...ence_v1.projects.locations.operations.html | 4 +-- .../authorizedbuyersmarketplace.v1alpha.json | 4 +-- .../documents/backupdr.v1.json | 4 +-- .../documents/bigtableadmin.v2.json | 4 +-- .../discovery_cache/documents/chat.v1.json | 4 +-- .../documents/cloudfunctions.v2.json | 6 ++-- .../documents/cloudfunctions.v2alpha.json | 6 ++-- .../documents/cloudfunctions.v2beta.json | 6 ++-- .../contactcenteraiplatform.v1alpha1.json | 4 +-- .../documents/datastore.v1.json | 4 +-- .../documents/datastore.v1beta3.json | 4 +-- .../documents/dialogflow.v2.json | 2 +- .../documents/dialogflow.v2beta1.json | 2 +- .../documents/dialogflow.v3.json | 2 +- .../documents/dialogflow.v3beta1.json | 2 +- .../documents/displayvideo.v2.json | 10 ++---- .../discovery_cache/documents/file.v1.json | 4 +-- .../documents/file.v1beta1.json | 4 +-- .../firebaseappdistribution.v1alpha.json | 13 +++----- .../merchantapi.accounts_v1beta.json | 10 ++++-- .../merchantapi.conversions_v1beta.json | 5 ++- .../merchantapi.datasources_v1beta.json | 5 ++- .../merchantapi.inventories_v1beta.json | 5 ++- .../documents/merchantapi.lfp_v1beta.json | 5 ++- .../merchantapi.notifications_v1beta.json | 5 ++- .../merchantapi.products_v1beta.json | 13 ++++++-- .../merchantapi.promotions_v1beta.json | 27 ++++++++++------ .../documents/merchantapi.quota_v1beta.json | 5 ++- .../documents/merchantapi.reports_v1beta.json | 8 ++++- .../documents/merchantapi.reviews_v1beta.json | 17 +++++++++- .../documents/networkmanagement.v1beta1.json | 6 ++-- .../documents/networksecurity.v1beta1.json | 10 +++--- .../playdeveloperreporting.v1alpha1.json | 10 +++--- .../playdeveloperreporting.v1beta1.json | 10 +++--- .../documents/realtimebidding.v1.json | 6 ++-- .../discovery_cache/documents/retail.v2.json | 4 +-- .../documents/retail.v2alpha.json | 4 +-- .../documents/retail.v2beta.json | 4 +-- .../discovery_cache/documents/script.v1.json | 4 +-- .../documents/videointelligence.v1.json | 6 ++-- 75 files changed, 229 insertions(+), 186 deletions(-) diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html index 945956efe3d..91b4628e533 100644 --- a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html @@ -120,7 +120,7 @@

Method Details

An object of the form: { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. - "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed. + "cpmFee": { # Represents an amount of money with its currency type. # Required. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. @@ -147,7 +147,7 @@

Method Details

The object takes the form of: { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. - "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed. + "cpmFee": { # Represents an amount of money with its currency type. # Required. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. @@ -167,7 +167,7 @@

Method Details

An object of the form: { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. - "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed. + "cpmFee": { # Represents an amount of money with its currency type. # Required. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. @@ -200,7 +200,7 @@

Method Details

An object of the form: { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. - "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed. + "cpmFee": { # Represents an amount of money with its currency type. # Required. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. @@ -227,7 +227,7 @@

Method Details

An object of the form: { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. - "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed. + "cpmFee": { # Represents an amount of money with its currency type. # Required. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. @@ -258,7 +258,7 @@

Method Details

{ # Response message for listing data segments. "dataSegments": [ # The list of data segments. { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. - "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed. + "cpmFee": { # Represents an amount of money with its currency type. # Required. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. @@ -297,7 +297,7 @@

Method Details

The object takes the form of: { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. - "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed. + "cpmFee": { # Represents an amount of money with its currency type. # Required. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. @@ -318,7 +318,7 @@

Method Details

An object of the form: { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. - "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed. + "cpmFee": { # Represents an amount of money with its currency type. # Required. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html index ea20466b674..88dcb4cdd16 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html @@ -123,7 +123,7 @@

Method Details

"daysOfWeek": [ # Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`. "A String", ], - "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. Value of hourly frequency should be between 6 and 23. Reason for limit : We found that there is bandwidth limitation of 3GB/S for GMI while taking a backup and 5GB/S while doing a restore. Given the amount of parallel backups and restore we are targeting, this will potentially take the backup time to mins and hours (in worst case scenario). + "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. Value of hourly frequency should be between 4 and 23. Reason for limit : We found that there is bandwidth limitation of 3GB/S for GMI while taking a backup and 5GB/S while doing a restore. Given the amount of parallel backups and restore we are targeting, this will potentially take the backup time to mins and hours (in worst case scenario). "months": [ # Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied. "A String", ], @@ -247,7 +247,7 @@

Method Details

"daysOfWeek": [ # Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`. "A String", ], - "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. Value of hourly frequency should be between 6 and 23. Reason for limit : We found that there is bandwidth limitation of 3GB/S for GMI while taking a backup and 5GB/S while doing a restore. Given the amount of parallel backups and restore we are targeting, this will potentially take the backup time to mins and hours (in worst case scenario). + "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. Value of hourly frequency should be between 4 and 23. Reason for limit : We found that there is bandwidth limitation of 3GB/S for GMI while taking a backup and 5GB/S while doing a restore. Given the amount of parallel backups and restore we are targeting, this will potentially take the backup time to mins and hours (in worst case scenario). "months": [ # Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied. "A String", ], @@ -311,7 +311,7 @@

Method Details

"daysOfWeek": [ # Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`. "A String", ], - "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. Value of hourly frequency should be between 6 and 23. Reason for limit : We found that there is bandwidth limitation of 3GB/S for GMI while taking a backup and 5GB/S while doing a restore. Given the amount of parallel backups and restore we are targeting, this will potentially take the backup time to mins and hours (in worst case scenario). + "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. Value of hourly frequency should be between 4 and 23. Reason for limit : We found that there is bandwidth limitation of 3GB/S for GMI while taking a backup and 5GB/S while doing a restore. Given the amount of parallel backups and restore we are targeting, this will potentially take the backup time to mins and hours (in worst case scenario). "months": [ # Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied. "A String", ], diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html index 4a241582b9b..46788a88be4 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html @@ -1415,7 +1415,7 @@

Method Details

}, } - updateMask: string, Required. The list of fields to update. A mask specifying which fields (e.g. `change_stream_config`) in the `table` field should be updated. This mask is relative to the `table` field, not to the request message. The wildcard (*) path is currently not supported. Currently UpdateTable is only supported for the following fields: * `change_stream_config` * `change_stream_config.retention_period` * `deletion_protection` If `column_families` is set in `update_mask`, it will return an UNIMPLEMENTED error. + updateMask: string, Required. The list of fields to update. A mask specifying which fields (e.g. `change_stream_config`) in the `table` field should be updated. This mask is relative to the `table` field, not to the request message. The wildcard (*) path is currently not supported. Currently UpdateTable is only supported for the following fields: * `change_stream_config` * `change_stream_config.retention_period` * `deletion_protection` * `automated_backup_policy` * `automated_backup_policy.retention_period` * `automated_backup_policy.frequency` If `column_families` is set in `update_mask`, it will return an UNIMPLEMENTED error. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/cloudfunctions_v2.projects.locations.functions.html b/docs/dyn/cloudfunctions_v2.projects.locations.functions.html index 146b14e12bd..8254faa1fde 100644 --- a/docs/dyn/cloudfunctions_v2.projects.locations.functions.html +++ b/docs/dyn/cloudfunctions_v2.projects.locations.functions.html @@ -956,7 +956,7 @@

Method Details

Args: parent: string, Required. The project and location from which the function should be listed, specified in the format `projects/*/locations/*` If you want to list functions in all locations, use "-" in place of a location. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations. (required) filter: string, The filter for Functions that match the filter expression, following the syntax outlined in https://google.aip.dev/160. - orderBy: string, The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. See https://google.aip.dev/132#ordering. + orderBy: string, The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting order is ascending. See https://google.aip.dev/132#ordering. pageSize: integer, Maximum number of functions to return per call. The largest allowed page_size is 1,000, if the page_size is omitted or specified as greater than 1,000 then it will be replaced as 1,000. The size of the list response can be less than specified when used with filters. pageToken: string, The value returned by the last `ListFunctionsResponse`; indicates that this is a continuation of a prior `ListFunctions` call, and that the system should return the next page of data. x__xgafv: string, V1 error format. diff --git a/docs/dyn/cloudfunctions_v2alpha.projects.locations.functions.html b/docs/dyn/cloudfunctions_v2alpha.projects.locations.functions.html index f8368ac71c8..432b5dda405 100644 --- a/docs/dyn/cloudfunctions_v2alpha.projects.locations.functions.html +++ b/docs/dyn/cloudfunctions_v2alpha.projects.locations.functions.html @@ -956,7 +956,7 @@

Method Details

Args: parent: string, Required. The project and location from which the function should be listed, specified in the format `projects/*/locations/*` If you want to list functions in all locations, use "-" in place of a location. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations. (required) filter: string, The filter for Functions that match the filter expression, following the syntax outlined in https://google.aip.dev/160. - orderBy: string, The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. See https://google.aip.dev/132#ordering. + orderBy: string, The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting order is ascending. See https://google.aip.dev/132#ordering. pageSize: integer, Maximum number of functions to return per call. The largest allowed page_size is 1,000, if the page_size is omitted or specified as greater than 1,000 then it will be replaced as 1,000. The size of the list response can be less than specified when used with filters. pageToken: string, The value returned by the last `ListFunctionsResponse`; indicates that this is a continuation of a prior `ListFunctions` call, and that the system should return the next page of data. x__xgafv: string, V1 error format. diff --git a/docs/dyn/cloudfunctions_v2beta.projects.locations.functions.html b/docs/dyn/cloudfunctions_v2beta.projects.locations.functions.html index d0303fa1a99..e067124d10c 100644 --- a/docs/dyn/cloudfunctions_v2beta.projects.locations.functions.html +++ b/docs/dyn/cloudfunctions_v2beta.projects.locations.functions.html @@ -956,7 +956,7 @@

Method Details

Args: parent: string, Required. The project and location from which the function should be listed, specified in the format `projects/*/locations/*` If you want to list functions in all locations, use "-" in place of a location. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations. (required) filter: string, The filter for Functions that match the filter expression, following the syntax outlined in https://google.aip.dev/160. - orderBy: string, The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. See https://google.aip.dev/132#ordering. + orderBy: string, The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting order is ascending. See https://google.aip.dev/132#ordering. pageSize: integer, Maximum number of functions to return per call. The largest allowed page_size is 1,000, if the page_size is omitted or specified as greater than 1,000 then it will be replaced as 1,000. The size of the list response can be less than specified when used with filters. pageToken: string, The value returned by the last `ListFunctionsResponse`; indicates that this is a continuation of a prior `ListFunctions` call, and that the system should return the next page of data. x__xgafv: string, V1 error format. diff --git a/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.html b/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.html index 14a63ddc571..125724db6d8 100644 --- a/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.html +++ b/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.html @@ -110,7 +110,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Message describing ContactCenter object Next ID: 24 +{ # Message describing ContactCenter object "adminUser": { # Message storing info about the first admin user. Next ID: 3 # Optional. Info about the first admin user, such as given name and family name. "familyName": "A String", # Optional. Last/family name of the first admin user. "givenName": "A String", # Optional. First/given name of the first admin user. @@ -284,7 +284,7 @@

Method Details

Returns: An object of the form: - { # Message describing ContactCenter object Next ID: 24 + { # Message describing ContactCenter object "adminUser": { # Message storing info about the first admin user. Next ID: 3 # Optional. Info about the first admin user, such as given name and family name. "familyName": "A String", # Optional. Last/family name of the first admin user. "givenName": "A String", # Optional. First/given name of the first admin user. @@ -398,7 +398,7 @@

Method Details

{ # Message for response to listing ContactCenters "contactCenters": [ # The list of ContactCenter - { # Message describing ContactCenter object Next ID: 24 + { # Message describing ContactCenter object "adminUser": { # Message storing info about the first admin user. Next ID: 3 # Optional. Info about the first admin user, such as given name and family name. "familyName": "A String", # Optional. Last/family name of the first admin user. "givenName": "A String", # Optional. First/given name of the first admin user. @@ -521,7 +521,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Message describing ContactCenter object Next ID: 24 +{ # Message describing ContactCenter object "adminUser": { # Message storing info about the first admin user. Next ID: 3 # Optional. Info about the first admin user, such as given name and family name. "familyName": "A String", # Optional. Last/family name of the first admin user. "givenName": "A String", # Optional. First/given name of the first admin user. diff --git a/docs/dyn/datastore_v1.projects.html b/docs/dyn/datastore_v1.projects.html index 014fc473700..b94ec23c467 100644 --- a/docs/dyn/datastore_v1.projects.html +++ b/docs/dyn/datastore_v1.projects.html @@ -1725,7 +1725,7 @@

Method Details

An object of the form: { # The response for Datastore.RunQuery. - "batch": { # A batch of results produced by a query. # A batch of query results (always present). + "batch": { # A batch of results produced by a query. # A batch of query results. This is always present unless running a query under explain-only mode: RunQueryRequest.explain_options was provided and ExplainOptions.analyze was set to false. "endCursor": "A String", # A cursor that points to the position after the last result in the batch. "entityResultType": "A String", # The result type for every entity in `entity_results`. "entityResults": [ # The results for this batch. diff --git a/docs/dyn/datastore_v1beta3.projects.html b/docs/dyn/datastore_v1beta3.projects.html index ba889141df5..bf8d379f70e 100644 --- a/docs/dyn/datastore_v1beta3.projects.html +++ b/docs/dyn/datastore_v1beta3.projects.html @@ -1528,7 +1528,7 @@

Method Details

An object of the form: { # The response for Datastore.RunQuery. - "batch": { # A batch of results produced by a query. # A batch of query results (always present). + "batch": { # A batch of results produced by a query. # A batch of query results. This is always present unless running a query under explain-only mode: RunQueryRequest.explain_options was provided and ExplainOptions.analyze was set to false. "endCursor": "A String", # A cursor that points to the position after the last result in the batch. "entityResultType": "A String", # The result type for every entity in `entity_results`. "entityResults": [ # The results for this batch. diff --git a/docs/dyn/file_v1.projects.locations.instances.html b/docs/dyn/file_v1.projects.locations.instances.html index 15cbcd4193b..34eed7b1849 100644 --- a/docs/dyn/file_v1.projects.locations.instances.html +++ b/docs/dyn/file_v1.projects.locations.instances.html @@ -171,7 +171,7 @@

Method Details

"fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. "maxIops": "A String", # Required. Maximum IOPS. }, - "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. + "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. "maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB. }, }, @@ -336,7 +336,7 @@

Method Details

"fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. "maxIops": "A String", # Required. Maximum IOPS. }, - "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. + "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. "maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB. }, }, @@ -442,7 +442,7 @@

Method Details

"fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. "maxIops": "A String", # Required. Maximum IOPS. }, - "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. + "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. "maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB. }, }, @@ -557,7 +557,7 @@

Method Details

"fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. "maxIops": "A String", # Required. Maximum IOPS. }, - "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. + "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. "maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB. }, }, diff --git a/docs/dyn/file_v1beta1.projects.locations.instances.html b/docs/dyn/file_v1beta1.projects.locations.instances.html index de7954d7a5b..6512d2d8127 100644 --- a/docs/dyn/file_v1beta1.projects.locations.instances.html +++ b/docs/dyn/file_v1beta1.projects.locations.instances.html @@ -190,7 +190,7 @@

Method Details

"fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. "maxIops": "A String", # Required. Maximum IOPS. }, - "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. + "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. "maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB. }, }, @@ -369,7 +369,7 @@

Method Details

"fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. "maxIops": "A String", # Required. Maximum IOPS. }, - "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. + "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. "maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB. }, }, @@ -489,7 +489,7 @@

Method Details

"fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. "maxIops": "A String", # Required. Maximum IOPS. }, - "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. + "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. "maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB. }, }, @@ -618,7 +618,7 @@

Method Details

"fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. "maxIops": "A String", # Required. Maximum IOPS. }, - "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. + "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. "maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB. }, }, diff --git a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.html b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.html index 3c2409bf0a4..adad435c22a 100644 --- a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.html +++ b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.html @@ -118,7 +118,6 @@

Method Details

"name": "A String", # Identifier. The name of the test configuration resource. Format: `projects/{project_number}/apps/{app_id}/testConfig` "roboCrawler": { # Configuration for Robo crawler # Optional. Configuration for Robo crawler "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test - "appDescription": "A String", # Optional. Describes the app to give the AI some context "steps": [ # Required. Steps to be accomplished by the AI { # A step to be accomplished by the AI "assertion": "A String", # An assertion to be checked by the AI @@ -163,7 +162,6 @@

Method Details

"name": "A String", # Identifier. The name of the test configuration resource. Format: `projects/{project_number}/apps/{app_id}/testConfig` "roboCrawler": { # Configuration for Robo crawler # Optional. Configuration for Robo crawler "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test - "appDescription": "A String", # Optional. Describes the app to give the AI some context "steps": [ # Required. Steps to be accomplished by the AI { # A step to be accomplished by the AI "assertion": "A String", # An assertion to be checked by the AI @@ -207,7 +205,6 @@

Method Details

"name": "A String", # Identifier. The name of the test configuration resource. Format: `projects/{project_number}/apps/{app_id}/testConfig` "roboCrawler": { # Configuration for Robo crawler # Optional. Configuration for Robo crawler "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test - "appDescription": "A String", # Optional. Describes the app to give the AI some context "steps": [ # Required. Steps to be accomplished by the AI { # A step to be accomplished by the AI "assertion": "A String", # An assertion to be checked by the AI diff --git a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html index 8086544dab9..5bfef7c993b 100644 --- a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html +++ b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html @@ -127,7 +127,6 @@

Method Details

{ # The results of running an automated test on a release. "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test. - "appDescription": "A String", # Optional. Describes the app to give the AI some context "steps": [ # Required. Steps to be accomplished by the AI { # A step to be accomplished by the AI "assertion": "A String", # An assertion to be checked by the AI @@ -263,7 +262,6 @@

Method Details

{ # The results of running an automated test on a release. "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test. - "appDescription": "A String", # Optional. Describes the app to give the AI some context "steps": [ # Required. Steps to be accomplished by the AI { # A step to be accomplished by the AI "assertion": "A String", # An assertion to be checked by the AI @@ -405,7 +403,6 @@

Method Details

{ # The results of running an automated test on a release. "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test. - "appDescription": "A String", # Optional. Describes the app to give the AI some context "steps": [ # Required. Steps to be accomplished by the AI { # A step to be accomplished by the AI "assertion": "A String", # An assertion to be checked by the AI @@ -557,7 +554,6 @@

Method Details

"releaseTests": [ # The tests listed. { # The results of running an automated test on a release. "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test. - "appDescription": "A String", # Optional. Describes the app to give the AI some context "steps": [ # Required. Steps to be accomplished by the AI { # A step to be accomplished by the AI "assertion": "A String", # An assertion to be checked by the AI diff --git a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.testCases.html b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.testCases.html index 6cc7056a93c..de0f9786566 100644 --- a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.testCases.html +++ b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.testCases.html @@ -112,7 +112,6 @@

Method Details

{ # AI test cases "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test. - "appDescription": "A String", # Optional. Describes the app to give the AI some context "steps": [ # Required. Steps to be accomplished by the AI { # A step to be accomplished by the AI "assertion": "A String", # An assertion to be checked by the AI @@ -138,7 +137,6 @@

Method Details

{ # AI test cases "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test. - "appDescription": "A String", # Optional. Describes the app to give the AI some context "steps": [ # Required. Steps to be accomplished by the AI { # A step to be accomplished by the AI "assertion": "A String", # An assertion to be checked by the AI @@ -188,7 +186,6 @@

Method Details

{ # AI test cases "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test. - "appDescription": "A String", # Optional. Describes the app to give the AI some context "steps": [ # Required. Steps to be accomplished by the AI { # A step to be accomplished by the AI "assertion": "A String", # An assertion to be checked by the AI @@ -225,7 +222,6 @@

Method Details

"testCases": [ # The test cases from the specified app. { # AI test cases "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test. - "appDescription": "A String", # Optional. Describes the app to give the AI some context "steps": [ # Required. Steps to be accomplished by the AI { # A step to be accomplished by the AI "assertion": "A String", # An assertion to be checked by the AI @@ -268,7 +264,6 @@

Method Details

{ # AI test cases "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test. - "appDescription": "A String", # Optional. Describes the app to give the AI some context "steps": [ # Required. Steps to be accomplished by the AI { # A step to be accomplished by the AI "assertion": "A String", # An assertion to be checked by the AI @@ -293,7 +288,6 @@

Method Details

{ # AI test cases "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test. - "appDescription": "A String", # Optional. Describes the app to give the AI some context "steps": [ # Required. Steps to be accomplished by the AI { # A step to be accomplished by the AI "assertion": "A String", # An assertion to be checked by the AI diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.html index 87bcccf1703..2ddedb0ccc0 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.html @@ -148,7 +148,7 @@

Instance Methods

Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.

list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. If no filter is provided, then it returns accounts the user is directly added to.

+

Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. If no filter is provided, then it returns accounts the user is directly added to. This method is eventually consistent, meaning changes such as creating, updating an account or a change of relationships between accounts may not show up in the results immediately. Instead, these changes propagate over a short period, after which the updated information can match the associated predicates. That means, that searching by account name might not return a recently changed account even though it satisfies the predicate.

listSubaccounts(provider, pageSize=None, pageToken=None, x__xgafv=None)

List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful `ListAccounts` method. This method will produce the same results as calling `ListsAccounts` with the following filter: `relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))`

@@ -293,7 +293,7 @@

Method Details

list(filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. If no filter is provided, then it returns accounts the user is directly added to.
+  
Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. If no filter is provided, then it returns accounts the user is directly added to. This method is eventually consistent, meaning changes such as creating, updating an account or a change of relationships between accounts may not show up in the results immediately. Instead, these changes propagate over a short period, after which the updated information can match the associated predicates. That means, that searching by account name might not return a recently changed account even though it satisfies the predicate.
 
 Args:
   filter: string, Optional. Returns only accounts that match the [filter](/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](/merchant/api/guides/accounts/filter-syntax).
diff --git a/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html b/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html
index 4e738846281..708e9432fd9 100644
--- a/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html
+++ b/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html
@@ -420,7 +420,7 @@ 

Method Details

"versionNumber": "A String", # Optional. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time. If set, the insertion is prevented when version number is lower than the current version number of the existing product. Re-insertion (for example, product refresh after 30 days) can be performed with the current `version_number`. Only supported for insertions into primary data sources. If the operation is prevented, the aborted exception will be thrown. } - dataSource: string, Required. The primary or supplemental product data source name. If the product already exists and data source provided is different, then the product will be moved to a new data source. Format: `accounts/{account}/dataSources/{datasource}`. + dataSource: string, Required. The primary or supplemental product data source name. If the product already exists and data source provided is different, then the product will be moved to a new data source. Only API data sources are supported. Format: `accounts/{account}/dataSources/{datasource}`. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.vpcFlowLogsConfigs.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.vpcFlowLogsConfigs.html index ba367482f27..fb3e147d00d 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.vpcFlowLogsConfigs.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.vpcFlowLogsConfigs.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

create(parent, body=None, vpcFlowLogsConfigId=None, x__xgafv=None)

-

Creates a new `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail. 2. The following fields are not considered as `settings` for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description

+

Creates a new `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail 2. The following fields are not considered as `settings` for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description

delete(name, x__xgafv=None)

Deletes a specific `VpcFlowLogsConfig`.

@@ -94,7 +94,7 @@

Instance Methods

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

-

Updates an existing `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Updating a configuration with state=DISABLED will fail. 2. The following fields are not considered as `settings` for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description

+

Creates a new `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail 2. The following fields are not considered as `settings` for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description

Method Details

close() @@ -103,7 +103,7 @@

Method Details

create(parent, body=None, vpcFlowLogsConfigId=None, x__xgafv=None) -
Creates a new `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail. 2. The following fields are not considered as `settings` for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description 
+  
Creates a new `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail 2. The following fields are not considered as `settings` for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description
 
 Args:
   parent: string, Required. The parent resource of the VPC Flow Logs configuration to create: `projects/{project_id}/locations/global` (required)
@@ -296,7 +296,7 @@ 

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates an existing `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Updating a configuration with state=DISABLED will fail. 2. The following fields are not considered as `settings` for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description 
+  
Creates a new `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail 2. The following fields are not considered as `settings` for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description
 
 Args:
   name: string, Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` (required)
diff --git a/docs/dyn/networksecurity_v1beta1.organizations.locations.securityProfiles.html b/docs/dyn/networksecurity_v1beta1.organizations.locations.securityProfiles.html
index bcca6980231..4c14b8cc514 100644
--- a/docs/dyn/networksecurity_v1beta1.organizations.locations.securityProfiles.html
+++ b/docs/dyn/networksecurity_v1beta1.organizations.locations.securityProfiles.html
@@ -112,11 +112,11 @@ 

Method Details

{ # SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. "createTime": "A String", # Output only. Resource creation timestamp. - "customInterceptProfile": { # CustomInterceptProfile defines the Packet Intercept Endpoint Group used to intercept traffic to a third-party firewall in a Firewall rule. # The custom TPPI configuration for the SecurityProfile. - "interceptEndpointGroup": "A String", # Required. The InterceptEndpointGroup to which traffic associated with the SP should be mirrored. + "customInterceptProfile": { # CustomInterceptProfile defines in-band integration behavior (intercept). It is used by firewall rules with an APPLY_SECURITY_PROFILE_GROUP action. # The custom TPPI configuration for the SecurityProfile. + "interceptEndpointGroup": "A String", # Required. The target InterceptEndpointGroup. When a firewall rule with this security profile attached matches a packet, the packet will be intercepted to the location-local target in this group. }, - "customMirroringProfile": { # CustomMirroringProfile defines an action for mirroring traffic to a collector's EndpointGroup # The custom Packet Mirroring v2 configuration for the SecurityProfile. - "mirroringEndpointGroup": "A String", # Required. The MirroringEndpointGroup to which traffic associated with the SP should be mirrored. + "customMirroringProfile": { # CustomMirroringProfile defines out-of-band integration behavior (mirroring). It is used by mirroring rules with a MIRROR action. # The custom Packet Mirroring v2 configuration for the SecurityProfile. + "mirroringEndpointGroup": "A String", # Required. The target MirroringEndpointGroup. When a mirroring rule with this security profile attached matches a packet, a replica will be mirrored to the location-local target in this group. }, "description": "A String", # Optional. An optional description of the profile. Max length 512 characters. "etag": "A String", # Output only. 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. @@ -225,11 +225,11 @@

Method Details

{ # SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. "createTime": "A String", # Output only. Resource creation timestamp. - "customInterceptProfile": { # CustomInterceptProfile defines the Packet Intercept Endpoint Group used to intercept traffic to a third-party firewall in a Firewall rule. # The custom TPPI configuration for the SecurityProfile. - "interceptEndpointGroup": "A String", # Required. The InterceptEndpointGroup to which traffic associated with the SP should be mirrored. + "customInterceptProfile": { # CustomInterceptProfile defines in-band integration behavior (intercept). It is used by firewall rules with an APPLY_SECURITY_PROFILE_GROUP action. # The custom TPPI configuration for the SecurityProfile. + "interceptEndpointGroup": "A String", # Required. The target InterceptEndpointGroup. When a firewall rule with this security profile attached matches a packet, the packet will be intercepted to the location-local target in this group. }, - "customMirroringProfile": { # CustomMirroringProfile defines an action for mirroring traffic to a collector's EndpointGroup # The custom Packet Mirroring v2 configuration for the SecurityProfile. - "mirroringEndpointGroup": "A String", # Required. The MirroringEndpointGroup to which traffic associated with the SP should be mirrored. + "customMirroringProfile": { # CustomMirroringProfile defines out-of-band integration behavior (mirroring). It is used by mirroring rules with a MIRROR action. # The custom Packet Mirroring v2 configuration for the SecurityProfile. + "mirroringEndpointGroup": "A String", # Required. The target MirroringEndpointGroup. When a mirroring rule with this security profile attached matches a packet, a replica will be mirrored to the location-local target in this group. }, "description": "A String", # Optional. An optional description of the profile. Max length 512 characters. "etag": "A String", # Output only. 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. @@ -278,11 +278,11 @@

Method Details

"securityProfiles": [ # List of SecurityProfile resources. { # SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. "createTime": "A String", # Output only. Resource creation timestamp. - "customInterceptProfile": { # CustomInterceptProfile defines the Packet Intercept Endpoint Group used to intercept traffic to a third-party firewall in a Firewall rule. # The custom TPPI configuration for the SecurityProfile. - "interceptEndpointGroup": "A String", # Required. The InterceptEndpointGroup to which traffic associated with the SP should be mirrored. + "customInterceptProfile": { # CustomInterceptProfile defines in-band integration behavior (intercept). It is used by firewall rules with an APPLY_SECURITY_PROFILE_GROUP action. # The custom TPPI configuration for the SecurityProfile. + "interceptEndpointGroup": "A String", # Required. The target InterceptEndpointGroup. When a firewall rule with this security profile attached matches a packet, the packet will be intercepted to the location-local target in this group. }, - "customMirroringProfile": { # CustomMirroringProfile defines an action for mirroring traffic to a collector's EndpointGroup # The custom Packet Mirroring v2 configuration for the SecurityProfile. - "mirroringEndpointGroup": "A String", # Required. The MirroringEndpointGroup to which traffic associated with the SP should be mirrored. + "customMirroringProfile": { # CustomMirroringProfile defines out-of-band integration behavior (mirroring). It is used by mirroring rules with a MIRROR action. # The custom Packet Mirroring v2 configuration for the SecurityProfile. + "mirroringEndpointGroup": "A String", # Required. The target MirroringEndpointGroup. When a mirroring rule with this security profile attached matches a packet, a replica will be mirrored to the location-local target in this group. }, "description": "A String", # Optional. An optional description of the profile. Max length 512 characters. "etag": "A String", # Output only. 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. @@ -337,11 +337,11 @@

Method Details

{ # SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. "createTime": "A String", # Output only. Resource creation timestamp. - "customInterceptProfile": { # CustomInterceptProfile defines the Packet Intercept Endpoint Group used to intercept traffic to a third-party firewall in a Firewall rule. # The custom TPPI configuration for the SecurityProfile. - "interceptEndpointGroup": "A String", # Required. The InterceptEndpointGroup to which traffic associated with the SP should be mirrored. + "customInterceptProfile": { # CustomInterceptProfile defines in-band integration behavior (intercept). It is used by firewall rules with an APPLY_SECURITY_PROFILE_GROUP action. # The custom TPPI configuration for the SecurityProfile. + "interceptEndpointGroup": "A String", # Required. The target InterceptEndpointGroup. When a firewall rule with this security profile attached matches a packet, the packet will be intercepted to the location-local target in this group. }, - "customMirroringProfile": { # CustomMirroringProfile defines an action for mirroring traffic to a collector's EndpointGroup # The custom Packet Mirroring v2 configuration for the SecurityProfile. - "mirroringEndpointGroup": "A String", # Required. The MirroringEndpointGroup to which traffic associated with the SP should be mirrored. + "customMirroringProfile": { # CustomMirroringProfile defines out-of-band integration behavior (mirroring). It is used by mirroring rules with a MIRROR action. # The custom Packet Mirroring v2 configuration for the SecurityProfile. + "mirroringEndpointGroup": "A String", # Required. The target MirroringEndpointGroup. When a mirroring rule with this security profile attached matches a packet, a replica will be mirrored to the location-local target in this group. }, "description": "A String", # Optional. An optional description of the profile. Max length 512 characters. "etag": "A String", # Output only. 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. diff --git a/docs/dyn/playdeveloperreporting_v1alpha1.vitals.excessivewakeuprate.html b/docs/dyn/playdeveloperreporting_v1alpha1.vitals.excessivewakeuprate.html index 747a78e7e54..baec38d69ed 100644 --- a/docs/dyn/playdeveloperreporting_v1alpha1.vitals.excessivewakeuprate.html +++ b/docs/dyn/playdeveloperreporting_v1alpha1.vitals.excessivewakeuprate.html @@ -182,7 +182,7 @@

Method Details

"year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, }, - "userCohort": "A String", # User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta android versions only, excluding data from released android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., "T1B2.220916.004". + "userCohort": "A String", # User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/playdeveloperreporting_v1alpha1.vitals.slowrenderingrate.html b/docs/dyn/playdeveloperreporting_v1alpha1.vitals.slowrenderingrate.html index 07a0f77aff0..45740c92432 100644 --- a/docs/dyn/playdeveloperreporting_v1alpha1.vitals.slowrenderingrate.html +++ b/docs/dyn/playdeveloperreporting_v1alpha1.vitals.slowrenderingrate.html @@ -182,7 +182,7 @@

Method Details

"year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, }, - "userCohort": "A String", # User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta Android versions only, excluding data from released Android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., "T1B2.220916.004". + "userCohort": "A String", # User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/playdeveloperreporting_v1alpha1.vitals.slowstartrate.html b/docs/dyn/playdeveloperreporting_v1alpha1.vitals.slowstartrate.html index 9db3df82462..0bfdbfb44ca 100644 --- a/docs/dyn/playdeveloperreporting_v1alpha1.vitals.slowstartrate.html +++ b/docs/dyn/playdeveloperreporting_v1alpha1.vitals.slowstartrate.html @@ -182,7 +182,7 @@

Method Details

"year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, }, - "userCohort": "A String", # User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta Android versions only, excluding data from released Android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., "T1B2.220916.004". + "userCohort": "A String", # User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/playdeveloperreporting_v1alpha1.vitals.stuckbackgroundwakelockrate.html b/docs/dyn/playdeveloperreporting_v1alpha1.vitals.stuckbackgroundwakelockrate.html index e69a0f86f3b..ec62c2cda50 100644 --- a/docs/dyn/playdeveloperreporting_v1alpha1.vitals.stuckbackgroundwakelockrate.html +++ b/docs/dyn/playdeveloperreporting_v1alpha1.vitals.stuckbackgroundwakelockrate.html @@ -182,7 +182,7 @@

Method Details

"year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, }, - "userCohort": "A String", # User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta android versions only, excluding data from released android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., "T1B2.220916.004". + "userCohort": "A String", # User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/playdeveloperreporting_v1beta1.vitals.excessivewakeuprate.html b/docs/dyn/playdeveloperreporting_v1beta1.vitals.excessivewakeuprate.html index 0b30ecbf551..d088f58885c 100644 --- a/docs/dyn/playdeveloperreporting_v1beta1.vitals.excessivewakeuprate.html +++ b/docs/dyn/playdeveloperreporting_v1beta1.vitals.excessivewakeuprate.html @@ -182,7 +182,7 @@

Method Details

"year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, }, - "userCohort": "A String", # User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta android versions only, excluding data from released android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., "T1B2.220916.004". + "userCohort": "A String", # User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/playdeveloperreporting_v1beta1.vitals.slowrenderingrate.html b/docs/dyn/playdeveloperreporting_v1beta1.vitals.slowrenderingrate.html index 808b846b729..08ec846d540 100644 --- a/docs/dyn/playdeveloperreporting_v1beta1.vitals.slowrenderingrate.html +++ b/docs/dyn/playdeveloperreporting_v1beta1.vitals.slowrenderingrate.html @@ -182,7 +182,7 @@

Method Details

"year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, }, - "userCohort": "A String", # User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta Android versions only, excluding data from released Android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., "T1B2.220916.004". + "userCohort": "A String", # User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/playdeveloperreporting_v1beta1.vitals.slowstartrate.html b/docs/dyn/playdeveloperreporting_v1beta1.vitals.slowstartrate.html index f3eeab49233..0478d1d78c9 100644 --- a/docs/dyn/playdeveloperreporting_v1beta1.vitals.slowstartrate.html +++ b/docs/dyn/playdeveloperreporting_v1beta1.vitals.slowstartrate.html @@ -182,7 +182,7 @@

Method Details

"year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, }, - "userCohort": "A String", # User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta Android versions only, excluding data from released Android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., "T1B2.220916.004". + "userCohort": "A String", # User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/playdeveloperreporting_v1beta1.vitals.stuckbackgroundwakelockrate.html b/docs/dyn/playdeveloperreporting_v1beta1.vitals.stuckbackgroundwakelockrate.html index 6e07a552a98..7b550a9c314 100644 --- a/docs/dyn/playdeveloperreporting_v1beta1.vitals.stuckbackgroundwakelockrate.html +++ b/docs/dyn/playdeveloperreporting_v1beta1.vitals.stuckbackgroundwakelockrate.html @@ -182,7 +182,7 @@

Method Details

"year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, }, - "userCohort": "A String", # User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta android versions only, excluding data from released android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., "T1B2.220916.004". + "userCohort": "A String", # User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/realtimebidding_v1.bidders.html b/docs/dyn/realtimebidding_v1.bidders.html index cceb0536844..58be56a1202 100644 --- a/docs/dyn/realtimebidding_v1.bidders.html +++ b/docs/dyn/realtimebidding_v1.bidders.html @@ -127,7 +127,7 @@

Method Details

An object of the form: { # Bidder settings. - "bypassNonguaranteedDealsPretargeting": True or False, # Output only. An option to bypass pretargeting for private auctions and preferred deals. When true, bid requests from these nonguaranteed deals will always be sent. When false, bid requests will be subject to regular pretargeting configurations. Programmatic Guaranteed deals will always be sent to the bidder, regardless of the value for this flag. Auction packages are not impacted by this value and are subject to the regular pretargeting configurations. + "bypassNonguaranteedDealsPretargeting": True or False, # Output only. An option to bypass pretargeting for private auctions and preferred deals. When true, bid requests from these nonguaranteed deals will always be sent. When false, bid requests will be subject to regular pretargeting configurations. Programmatic Guaranteed deals will always be sent to the bidder, regardless of the value for this option. Auction packages are not impacted by this value and are subject to the regular pretargeting configurations. "cookieMatchingNetworkId": "A String", # Output only. The buyer's network ID used for cookie matching. This ID corresponds to the `google_nid` parameter in the URL used in cookie match requests. Refer to https://developers.google.com/authorized-buyers/rtb/cookie-guide for further information. "cookieMatchingUrl": "A String", # Output only. The base URL used in cookie match requests. Refer to https://developers.google.com/authorized-buyers/rtb/cookie-guide for further information. "dealsBillingId": "A String", # Output only. The billing ID for the deals pretargeting config. This billing ID is sent on the bid request for guaranteed and nonguaranteed deals matched in pretargeting. @@ -153,7 +153,7 @@

Method Details

{ # A response containing bidders. "bidders": [ # List of bidders. { # Bidder settings. - "bypassNonguaranteedDealsPretargeting": True or False, # Output only. An option to bypass pretargeting for private auctions and preferred deals. When true, bid requests from these nonguaranteed deals will always be sent. When false, bid requests will be subject to regular pretargeting configurations. Programmatic Guaranteed deals will always be sent to the bidder, regardless of the value for this flag. Auction packages are not impacted by this value and are subject to the regular pretargeting configurations. + "bypassNonguaranteedDealsPretargeting": True or False, # Output only. An option to bypass pretargeting for private auctions and preferred deals. When true, bid requests from these nonguaranteed deals will always be sent. When false, bid requests will be subject to regular pretargeting configurations. Programmatic Guaranteed deals will always be sent to the bidder, regardless of the value for this option. Auction packages are not impacted by this value and are subject to the regular pretargeting configurations. "cookieMatchingNetworkId": "A String", # Output only. The buyer's network ID used for cookie matching. This ID corresponds to the `google_nid` parameter in the URL used in cookie match requests. Refer to https://developers.google.com/authorized-buyers/rtb/cookie-guide for further information. "cookieMatchingUrl": "A String", # Output only. The base URL used in cookie match requests. Refer to https://developers.google.com/authorized-buyers/rtb/cookie-guide for further information. "dealsBillingId": "A String", # Output only. The billing ID for the deals pretargeting config. This billing ID is sent on the bid request for guaranteed and nonguaranteed deals matched in pretargeting. diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2.projects.locations.catalogs.placements.html index 4acc476c709..d66862f75cd 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.placements.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.placements.html @@ -462,7 +462,7 @@

Method Details

"mode": "A String", # The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO. }, "tileNavigationSpec": { # This field specifies tile navigation related parameters. # Optional. This field specifies tile navigation related parameters. - "appliedTiles": [ # This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter. + "appliedTiles": [ # This optional field specifies the tiles which are already clicked in client side. While the feature works without this field set, particularly for an initial query, it is highly recommended to set this field because it can improve the quality of the search response and removes possible duplicate tiles. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter. { # This field specifies the tile information including an attribute key, attribute value. More fields will be added in the future, eg: product id or product counts, etc. "productAttributeInterval": { # Product attribute name and numeric interval. # The product attribute key-numeric interval. "interval": { # A floating point interval. # The numeric interval (e.g. [10, 20)) diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html index 01f72473c8b..a35ebcee291 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html @@ -1013,7 +1013,7 @@

Method Details

"mode": "A String", # The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO. }, "tileNavigationSpec": { # This field specifies tile navigation related parameters. # Optional. This field specifies tile navigation related parameters. - "appliedTiles": [ # This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter. + "appliedTiles": [ # This optional field specifies the tiles which are already clicked in client side. While the feature works without this field set, particularly for an initial query, it is highly recommended to set this field because it can improve the quality of the search response and removes possible duplicate tiles. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter. { # This field specifies the tile information including an attribute key, attribute value. More fields will be added in the future, eg: product id or product counts, etc. "productAttributeInterval": { # Product attribute name and numeric interval. # The product attribute key-numeric interval. "interval": { # A floating point interval. # The numeric interval (e.g. [10, 20)) diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html index 30e33a39448..bce01680e81 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html @@ -463,7 +463,7 @@

Method Details

"mode": "A String", # The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO. }, "tileNavigationSpec": { # This field specifies tile navigation related parameters. # Optional. This field specifies tile navigation related parameters. - "appliedTiles": [ # This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter. + "appliedTiles": [ # This optional field specifies the tiles which are already clicked in client side. While the feature works without this field set, particularly for an initial query, it is highly recommended to set this field because it can improve the quality of the search response and removes possible duplicate tiles. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter. { # This field specifies the tile information including an attribute key, attribute value. More fields will be added in the future, eg: product id or product counts, etc. "productAttributeInterval": { # Product attribute name and numeric interval. # The product attribute key-numeric interval. "interval": { # A floating point interval. # The numeric interval (e.g. [10, 20)) diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html index 9f575bebb19..1f000304967 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html @@ -1014,7 +1014,7 @@

Method Details

"mode": "A String", # The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO. }, "tileNavigationSpec": { # This field specifies tile navigation related parameters. # Optional. This field specifies tile navigation related parameters. - "appliedTiles": [ # This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter. + "appliedTiles": [ # This optional field specifies the tiles which are already clicked in client side. While the feature works without this field set, particularly for an initial query, it is highly recommended to set this field because it can improve the quality of the search response and removes possible duplicate tiles. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter. { # This field specifies the tile information including an attribute key, attribute value. More fields will be added in the future, eg: product id or product counts, etc. "productAttributeInterval": { # Product attribute name and numeric interval. # The product attribute key-numeric interval. "interval": { # A floating point interval. # The numeric interval (e.g. [10, 20)) diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html index c8cd66edade..c28ff38dd9c 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html @@ -462,7 +462,7 @@

Method Details

"mode": "A String", # The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO. }, "tileNavigationSpec": { # This field specifies tile navigation related parameters. # Optional. This field specifies tile navigation related parameters. - "appliedTiles": [ # This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter. + "appliedTiles": [ # This optional field specifies the tiles which are already clicked in client side. While the feature works without this field set, particularly for an initial query, it is highly recommended to set this field because it can improve the quality of the search response and removes possible duplicate tiles. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter. { # This field specifies the tile information including an attribute key, attribute value. More fields will be added in the future, eg: product id or product counts, etc. "productAttributeInterval": { # Product attribute name and numeric interval. # The product attribute key-numeric interval. "interval": { # A floating point interval. # The numeric interval (e.g. [10, 20)) diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html index 998cee2a5be..4f26d6da5ef 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html @@ -1013,7 +1013,7 @@

Method Details

"mode": "A String", # The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO. }, "tileNavigationSpec": { # This field specifies tile navigation related parameters. # Optional. This field specifies tile navigation related parameters. - "appliedTiles": [ # This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter. + "appliedTiles": [ # This optional field specifies the tiles which are already clicked in client side. While the feature works without this field set, particularly for an initial query, it is highly recommended to set this field because it can improve the quality of the search response and removes possible duplicate tiles. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter. { # This field specifies the tile information including an attribute key, attribute value. More fields will be added in the future, eg: product id or product counts, etc. "productAttributeInterval": { # Product attribute name and numeric interval. # The product attribute key-numeric interval. "interval": { # A floating point interval. # The numeric interval (e.g. [10, 20)) diff --git a/docs/dyn/script_v1.scripts.html b/docs/dyn/script_v1.scripts.html index 65057596c79..8e820588fad 100644 --- a/docs/dyn/script_v1.scripts.html +++ b/docs/dyn/script_v1.scripts.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

run(scriptId, body=None, x__xgafv=None)

-

Runs a function in an Apps Script project. The script project must be deployed for use with the Apps Script API and the calling application must share the same Cloud Platform project. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the [Authorization](#authorization-scopes) section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the script project **Overview** page and scroll down to "Project OAuth Scopes." The error `403, PERMISSION_DENIED: The caller does not have permission` indicates that the Cloud Platform project used to authorize the request is not the same as the one used by the script.

+

Method Details

close() @@ -88,7 +88,7 @@

Method Details

run(scriptId, body=None, x__xgafv=None) -
Runs a function in an Apps Script project. The script project must be deployed for use with the Apps Script API and the calling application must share the same Cloud Platform project. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the [Authorization](#authorization-scopes) section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the script project **Overview** page and scroll down to "Project OAuth Scopes." The error `403, PERMISSION_DENIED: The caller does not have permission` indicates that the Cloud Platform project used to authorize the request is not the same as the one used by the script.
+  
 
 Args:
   scriptId: string, The script ID of the script to be executed. Find the script ID on the **Project settings** page under "IDs." As multiple executable APIs can be deployed in new IDE for same script, this field should be populated with DeploymentID generated while deploying in new IDE instead of script ID. (required)
diff --git a/docs/dyn/videointelligence_v1.operations.projects.locations.operations.html b/docs/dyn/videointelligence_v1.operations.projects.locations.operations.html
index a2a2df72104..e735ac09817 100644
--- a/docs/dyn/videointelligence_v1.operations.projects.locations.operations.html
+++ b/docs/dyn/videointelligence_v1.operations.projects.locations.operations.html
@@ -76,7 +76,7 @@ 

Cloud Video Intelligence API . Instance Methods

cancel(name, x__xgafv=None)

-

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

close()

Close httplib2 connections.

@@ -89,7 +89,7 @@

Instance Methods

Method Details

cancel(name, x__xgafv=None) -
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+  
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
 
 Args:
   name: string, The name of the operation resource to be cancelled. (required)
diff --git a/docs/dyn/videointelligence_v1.projects.locations.operations.html b/docs/dyn/videointelligence_v1.projects.locations.operations.html
index 2d3ee3da999..963dab7e733 100644
--- a/docs/dyn/videointelligence_v1.projects.locations.operations.html
+++ b/docs/dyn/videointelligence_v1.projects.locations.operations.html
@@ -76,7 +76,7 @@ 

Cloud Video Intelligence API . Instance Methods

cancel(name, body=None, x__xgafv=None)

-

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

close()

Close httplib2 connections.

@@ -95,7 +95,7 @@

Instance Methods

Method Details

cancel(name, body=None, x__xgafv=None) -
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+  
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
 
 Args:
   name: string, The name of the operation resource to be cancelled. (required)
diff --git a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json
index 40e145caaf5..35a70ddb63c 100644
--- a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json
@@ -1550,7 +1550,7 @@
 }
 }
 },
-"revision": "20250113",
+"revision": "20250205",
 "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/",
 "schemas": {
 "AcceptProposalRequest": {
@@ -1974,7 +1974,7 @@
 "properties": {
 "cpmFee": {
 "$ref": "Money",
-"description": "Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed."
+"description": "Required. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed."
 },
 "createTime": {
 "description": "Output only. Time the data segment was created.",
diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json
index e14354d6b2d..19aec668123 100644
--- a/googleapiclient/discovery_cache/documents/backupdr.v1.json
+++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json
@@ -1745,7 +1745,7 @@
 }
 }
 },
-"revision": "20250122",
+"revision": "20250129",
 "rootUrl": "https://backupdr.googleapis.com/",
 "schemas": {
 "AbandonBackupRequest": {
@@ -4775,7 +4775,7 @@
 "type": "array"
 },
 "hourlyFrequency": {
-"description": "Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. Value of hourly frequency should be between 6 and 23. Reason for limit : We found that there is bandwidth limitation of 3GB/S for GMI while taking a backup and 5GB/S while doing a restore. Given the amount of parallel backups and restore we are targeting, this will potentially take the backup time to mins and hours (in worst case scenario).",
+"description": "Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. Value of hourly frequency should be between 4 and 23. Reason for limit : We found that there is bandwidth limitation of 3GB/S for GMI while taking a backup and 5GB/S while doing a restore. Given the amount of parallel backups and restore we are targeting, this will potentially take the backup time to mins and hours (in worst case scenario).",
 "format": "int32",
 "type": "integer"
 },
diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json
index 92206901774..c91db60f289 100644
--- a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json
+++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json
@@ -1668,7 +1668,7 @@
 "type": "string"
 },
 "updateMask": {
-"description": "Required. The list of fields to update. A mask specifying which fields (e.g. `change_stream_config`) in the `table` field should be updated. This mask is relative to the `table` field, not to the request message. The wildcard (*) path is currently not supported. Currently UpdateTable is only supported for the following fields: * `change_stream_config` * `change_stream_config.retention_period` * `deletion_protection` If `column_families` is set in `update_mask`, it will return an UNIMPLEMENTED error.",
+"description": "Required. The list of fields to update. A mask specifying which fields (e.g. `change_stream_config`) in the `table` field should be updated. This mask is relative to the `table` field, not to the request message. The wildcard (*) path is currently not supported. Currently UpdateTable is only supported for the following fields: * `change_stream_config` * `change_stream_config.retention_period` * `deletion_protection` * `automated_backup_policy` * `automated_backup_policy.retention_period` * `automated_backup_policy.frequency` If `column_families` is set in `update_mask`, it will return an UNIMPLEMENTED error.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -2194,7 +2194,7 @@
 }
 }
 },
-"revision": "20241203",
+"revision": "20250131",
 "rootUrl": "https://bigtableadmin.googleapis.com/",
 "schemas": {
 "AppProfile": {
diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json
index 93493d4307f..2eee1948dd9 100644
--- a/googleapiclient/discovery_cache/documents/chat.v1.json
+++ b/googleapiclient/discovery_cache/documents/chat.v1.json
@@ -1344,7 +1344,7 @@
 }
 }
 },
-"revision": "20250126",
+"revision": "20250130",
 "rootUrl": "https://chat.googleapis.com/",
 "schemas": {
 "AccessSettings": {
@@ -2001,7 +2001,7 @@
 "description": "Represents information about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes information submitted by users interacting with [dialogs](https://developers.google.com/workspace/chat/dialogs), like data entered on a card."
 },
 "configCompleteRedirectUrl": {
-"description": "For `MESSAGE` interaction events, the URL that users must be redirected to after they complete an authorization or configuration flow outside of Google Chat. For more information, see [Connect a Chat app with other services and tools](https://developers.google.com/workspace/chat/connect-web-services-tools).",
+"description": "This URL is populated for `MESSAGE` and `ADDED_TO_SPACE` interaction events. After completing an authorization or configuration flow outside of Google Chat, users must be redirected to this URL to signal to Google Chat that the authorization or configuration flow was successful. For more information, see [Connect a Chat app with other services and tools](https://developers.google.com/workspace/chat/connect-web-services-tools). In [Developer Preview](https://developers.google.com/workspace/preview), this URL is also populated for `APP_COMMAND` interaction events.",
 "type": "string"
 },
 "dialogEventType": {
diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json
index 78e65a0d5b5..bc434d13a1c 100644
--- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json
+++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json
@@ -428,7 +428,7 @@
 "type": "string"
 },
 "orderBy": {
-"description": "The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. See https://google.aip.dev/132#ordering.",
+"description": "The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting order is ascending. See https://google.aip.dev/132#ordering.",
 "location": "query",
 "type": "string"
 },
@@ -744,7 +744,7 @@
 }
 }
 },
-"revision": "20250124",
+"revision": "20250130",
 "rootUrl": "https://cloudfunctions.googleapis.com/",
 "schemas": {
 "AbortFunctionUpgradeRequest": {
@@ -1342,7 +1342,7 @@
 ],
 "enumDescriptions": [
 "Not specified. Invalid name.",
-"Artifact Regsitry Stage",
+"Artifact Registry Stage",
 "Build Stage",
 "Service Stage",
 "Trigger Stage",
diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json
index 54397ad2500..9e60b9e68dc 100644
--- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json
+++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json
@@ -428,7 +428,7 @@
 "type": "string"
 },
 "orderBy": {
-"description": "The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. See https://google.aip.dev/132#ordering.",
+"description": "The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting order is ascending. See https://google.aip.dev/132#ordering.",
 "location": "query",
 "type": "string"
 },
@@ -744,7 +744,7 @@
 }
 }
 },
-"revision": "20250124",
+"revision": "20250130",
 "rootUrl": "https://cloudfunctions.googleapis.com/",
 "schemas": {
 "AbortFunctionUpgradeRequest": {
@@ -1342,7 +1342,7 @@
 ],
 "enumDescriptions": [
 "Not specified. Invalid name.",
-"Artifact Regsitry Stage",
+"Artifact Registry Stage",
 "Build Stage",
 "Service Stage",
 "Trigger Stage",
diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json
index f5600309d92..1ef2df7159e 100644
--- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json
+++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json
@@ -428,7 +428,7 @@
 "type": "string"
 },
 "orderBy": {
-"description": "The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. See https://google.aip.dev/132#ordering.",
+"description": "The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting order is ascending. See https://google.aip.dev/132#ordering.",
 "location": "query",
 "type": "string"
 },
@@ -744,7 +744,7 @@
 }
 }
 },
-"revision": "20250124",
+"revision": "20250130",
 "rootUrl": "https://cloudfunctions.googleapis.com/",
 "schemas": {
 "AbortFunctionUpgradeRequest": {
@@ -1342,7 +1342,7 @@
 ],
 "enumDescriptions": [
 "Not specified. Invalid name.",
-"Artifact Regsitry Stage",
+"Artifact Registry Stage",
 "Build Stage",
 "Service Stage",
 "Trigger Stage",
diff --git a/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json b/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json
index f3694a82969..5e47298fd78 100644
--- a/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json
+++ b/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json
@@ -512,7 +512,7 @@
 }
 }
 },
-"revision": "20241205",
+"revision": "20250129",
 "rootUrl": "https://contactcenteraiplatform.googleapis.com/",
 "schemas": {
 "AdminUser": {
@@ -555,7 +555,7 @@
 "type": "object"
 },
 "ContactCenter": {
-"description": "Message describing ContactCenter object Next ID: 24",
+"description": "Message describing ContactCenter object",
 "id": "ContactCenter",
 "properties": {
 "adminUser": {
diff --git a/googleapiclient/discovery_cache/documents/datastore.v1.json b/googleapiclient/discovery_cache/documents/datastore.v1.json
index e162c869100..e388ea30ec6 100644
--- a/googleapiclient/discovery_cache/documents/datastore.v1.json
+++ b/googleapiclient/discovery_cache/documents/datastore.v1.json
@@ -654,7 +654,7 @@
 }
 }
 },
-"revision": "20241204",
+"revision": "20250204",
 "rootUrl": "https://datastore.googleapis.com/",
 "schemas": {
 "Aggregation": {
@@ -2609,7 +2609,7 @@
 "properties": {
 "batch": {
 "$ref": "QueryResultBatch",
-"description": "A batch of query results (always present)."
+"description": "A batch of query results. This is always present unless running a query under explain-only mode: RunQueryRequest.explain_options was provided and ExplainOptions.analyze was set to false."
 },
 "explainMetrics": {
 "$ref": "ExplainMetrics",
diff --git a/googleapiclient/discovery_cache/documents/datastore.v1beta3.json b/googleapiclient/discovery_cache/documents/datastore.v1beta3.json
index 2505dcb740b..83ac451cfe9 100644
--- a/googleapiclient/discovery_cache/documents/datastore.v1beta3.json
+++ b/googleapiclient/discovery_cache/documents/datastore.v1beta3.json
@@ -336,7 +336,7 @@
 }
 }
 },
-"revision": "20241018",
+"revision": "20250204",
 "rootUrl": "https://datastore.googleapis.com/",
 "schemas": {
 "Aggregation": {
@@ -2034,7 +2034,7 @@
 "properties": {
 "batch": {
 "$ref": "QueryResultBatch",
-"description": "A batch of query results (always present)."
+"description": "A batch of query results. This is always present unless running a query under explain-only mode: RunQueryRequest.explain_options was provided and ExplainOptions.analyze was set to false."
 },
 "explainMetrics": {
 "$ref": "ExplainMetrics",
diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2.json b/googleapiclient/discovery_cache/documents/dialogflow.v2.json
index b6875f7b45c..c2303aeacc3 100644
--- a/googleapiclient/discovery_cache/documents/dialogflow.v2.json
+++ b/googleapiclient/discovery_cache/documents/dialogflow.v2.json
@@ -8714,7 +8714,7 @@
 }
 }
 },
-"revision": "20250121",
+"revision": "20250207",
 "rootUrl": "https://dialogflow.googleapis.com/",
 "schemas": {
 "GoogleCloudDialogflowCxV3AdvancedSettings": {
diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json
index d073f868fc4..c9d23e1346b 100644
--- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json
+++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json
@@ -8239,7 +8239,7 @@
 }
 }
 },
-"revision": "20250121",
+"revision": "20250207",
 "rootUrl": "https://dialogflow.googleapis.com/",
 "schemas": {
 "GoogleCloudDialogflowCxV3AdvancedSettings": {
diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3.json b/googleapiclient/discovery_cache/documents/dialogflow.v3.json
index b889b6d48f9..37b8c3e48c4 100644
--- a/googleapiclient/discovery_cache/documents/dialogflow.v3.json
+++ b/googleapiclient/discovery_cache/documents/dialogflow.v3.json
@@ -4453,7 +4453,7 @@
 }
 }
 },
-"revision": "20250121",
+"revision": "20250207",
 "rootUrl": "https://dialogflow.googleapis.com/",
 "schemas": {
 "GoogleCloudDialogflowCxV3AdvancedSettings": {
diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json
index d047c7f6784..e3ed79fc0ac 100644
--- a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json
+++ b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json
@@ -5185,7 +5185,7 @@
 }
 }
 },
-"revision": "20250121",
+"revision": "20250207",
 "rootUrl": "https://dialogflow.googleapis.com/",
 "schemas": {
 "GoogleCloudDialogflowCxV3AdvancedSettings": {
diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v2.json b/googleapiclient/discovery_cache/documents/displayvideo.v2.json
index 43324498f1a..949188f93be 100644
--- a/googleapiclient/discovery_cache/documents/displayvideo.v2.json
+++ b/googleapiclient/discovery_cache/documents/displayvideo.v2.json
@@ -8010,7 +8010,7 @@
 }
 }
 },
-"revision": "20250124",
+"revision": "20250205",
 "rootUrl": "https://displayvideo.googleapis.com/",
 "schemas": {
 "ActivateManualTriggerRequest": {
@@ -11425,15 +11425,11 @@ false
 "description": "Required. Immutable. The type of custom bidding algorithm.",
 "enum": [
 "CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED",
-"SCRIPT_BASED",
-"ADS_DATA_HUB_BASED",
-"GOAL_BUILDER_BASED"
+"SCRIPT_BASED"
 ],
 "enumDescriptions": [
 "Algorithm type is not specified or is unknown in this version.",
-"Algorithm generated through customer-uploaded custom bidding script files.",
-"Algorithm created through Ads Data Hub product.",
-"Algorithm created through goal builder in DV3 UI."
+"Algorithm generated through customer-uploaded custom bidding script files."
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/file.v1.json b/googleapiclient/discovery_cache/documents/file.v1.json
index d1b6e4f6713..a805b39ef1f 100644
--- a/googleapiclient/discovery_cache/documents/file.v1.json
+++ b/googleapiclient/discovery_cache/documents/file.v1.json
@@ -907,7 +907,7 @@
 }
 }
 },
-"revision": "20250106",
+"revision": "20250129",
 "rootUrl": "https://file.googleapis.com/",
 "schemas": {
 "Backup": {
@@ -2035,7 +2035,7 @@
 },
 "iopsPerTb": {
 "$ref": "IOPSPerTB",
-"description": "Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error."
+"description": "Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error."
 }
 },
 "type": "object"
diff --git a/googleapiclient/discovery_cache/documents/file.v1beta1.json b/googleapiclient/discovery_cache/documents/file.v1beta1.json
index c73f9935cd3..0e93ba996b5 100644
--- a/googleapiclient/discovery_cache/documents/file.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/file.v1beta1.json
@@ -1074,7 +1074,7 @@
 }
 }
 },
-"revision": "20250106",
+"revision": "20250129",
 "rootUrl": "https://file.googleapis.com/",
 "schemas": {
 "Backup": {
@@ -2304,7 +2304,7 @@
 },
 "iopsPerTb": {
 "$ref": "IOPSPerTB",
-"description": "Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error."
+"description": "Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error."
 }
 },
 "type": "object"
diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json
index 08b7af46600..50168548be2 100644
--- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json
@@ -776,7 +776,7 @@
 }
 }
 },
-"revision": "20250123",
+"revision": "20250207",
 "rootUrl": "https://firebaseappdistribution.googleapis.com/",
 "schemas": {
 "AndroidxCrawlerOutputPoint": {
@@ -907,11 +907,6 @@
 "description": "Instructions for AI driven test",
 "id": "GoogleFirebaseAppdistroV1alphaAiInstructions",
 "properties": {
-"appDescription": {
-"deprecated": true,
-"description": "Optional. Describes the app to give the AI some context",
-"type": "string"
-},
 "steps": {
 "description": "Required. Steps to be accomplished by the AI",
 "items": {
@@ -1402,7 +1397,8 @@
 "APP_NAME_TOO_LONG",
 "AAB_DEVELOPER_ACCOUNT_NOT_LINKED",
 "AAB_NO_APP_WITH_GIVEN_PACKAGE_NAME_IN_ACCOUNT",
-"AAB_UPLOAD_ERROR"
+"AAB_UPLOAD_ERROR",
+"APP_NOT_FOUND"
 ],
 "enumDescriptions": [
 "",
@@ -1426,7 +1422,8 @@
 "",
 "",
 "",
-""
+"",
+"Happens if the Firebase app no longer exists by the time of extraction"
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json
index 30d0404571a..89364262c7a 100644
--- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json
+++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json
@@ -181,7 +181,7 @@
 ]
 },
 "list": {
-"description": "Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. If no filter is provided, then it returns accounts the user is directly added to.",
+"description": "Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. If no filter is provided, then it returns accounts the user is directly added to. This method is eventually consistent, meaning changes such as creating, updating an account or a change of relationships between accounts may not show up in the results immediately. Instead, these changes propagate over a short period, after which the updated information can match the associated predicates. That means, that searching by account name might not return a recently changed account even though it satisfies the predicate.",
 "flatPath": "accounts/v1beta/accounts",
 "httpMethod": "GET",
 "id": "merchantapi.accounts.list",
@@ -1417,7 +1417,7 @@
 }
 }
 },
-"revision": "20250125",
+"revision": "20250203",
 "rootUrl": "https://merchantapi.googleapis.com/",
 "schemas": {
 "Accepted": {
@@ -2176,6 +2176,7 @@
 "FREE_LISTINGS",
 "FREE_LOCAL_LISTINGS",
 "FREE_LOCAL_VEHICLE_LISTINGS",
+"YOUTUBE_AFFILIATE",
 "YOUTUBE_SHOPPING",
 "CLOUD_RETAIL",
 "LOCAL_CLOUD_RETAIL",
@@ -2201,6 +2202,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -2216,6 +2218,7 @@ false
 "[Free product listings](https://support.google.com/merchants/answer/9199328).",
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
 "[Cloud retail](https://cloud.google.com/solutions/retail).",
 "[Local cloud retail](https://cloud.google.com/solutions/retail).",
@@ -2712,6 +2715,7 @@ false
 "FREE_LISTINGS",
 "FREE_LOCAL_LISTINGS",
 "FREE_LOCAL_VEHICLE_LISTINGS",
+"YOUTUBE_AFFILIATE",
 "YOUTUBE_SHOPPING",
 "CLOUD_RETAIL",
 "LOCAL_CLOUD_RETAIL",
@@ -2737,6 +2741,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -2752,6 +2757,7 @@ false
 "[Free product listings](https://support.google.com/merchants/answer/9199328).",
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
 "[Cloud retail](https://cloud.google.com/solutions/retail).",
 "[Local cloud retail](https://cloud.google.com/solutions/retail).",
diff --git a/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json
index 4fb57bb3986..45f1a6d51a1 100644
--- a/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json
+++ b/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json
@@ -295,7 +295,7 @@
 }
 }
 },
-"revision": "20250118",
+"revision": "20250203",
 "rootUrl": "https://merchantapi.googleapis.com/",
 "schemas": {
 "AttributionSettings": {
@@ -516,6 +516,7 @@
 "FREE_LISTINGS",
 "FREE_LOCAL_LISTINGS",
 "FREE_LOCAL_VEHICLE_LISTINGS",
+"YOUTUBE_AFFILIATE",
 "YOUTUBE_SHOPPING",
 "CLOUD_RETAIL",
 "LOCAL_CLOUD_RETAIL",
@@ -541,6 +542,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -556,6 +558,7 @@ false
 "[Free product listings](https://support.google.com/merchants/answer/9199328).",
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
 "[Cloud retail](https://cloud.google.com/solutions/retail).",
 "[Local cloud retail](https://cloud.google.com/solutions/retail).",
diff --git a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json
index 6487a8bc43d..a80189df16f 100644
--- a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json
+++ b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json
@@ -321,7 +321,7 @@
 }
 }
 },
-"revision": "20250108",
+"revision": "20250203",
 "rootUrl": "https://merchantapi.googleapis.com/",
 "schemas": {
 "DataSource": {
@@ -775,6 +775,7 @@
 "FREE_LISTINGS",
 "FREE_LOCAL_LISTINGS",
 "FREE_LOCAL_VEHICLE_LISTINGS",
+"YOUTUBE_AFFILIATE",
 "YOUTUBE_SHOPPING",
 "CLOUD_RETAIL",
 "LOCAL_CLOUD_RETAIL",
@@ -800,6 +801,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -815,6 +817,7 @@ false
 "[Free product listings](https://support.google.com/merchants/answer/9199328).",
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
 "[Cloud retail](https://cloud.google.com/solutions/retail).",
 "[Local cloud retail](https://cloud.google.com/solutions/retail).",
diff --git a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json
index c9d96637fe9..17f737f0ff5 100644
--- a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json
+++ b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json
@@ -300,7 +300,7 @@
 }
 }
 },
-"revision": "20241119",
+"revision": "20250203",
 "rootUrl": "https://merchantapi.googleapis.com/",
 "schemas": {
 "CustomAttribute": {
@@ -493,6 +493,7 @@
 "FREE_LISTINGS",
 "FREE_LOCAL_LISTINGS",
 "FREE_LOCAL_VEHICLE_LISTINGS",
+"YOUTUBE_AFFILIATE",
 "YOUTUBE_SHOPPING",
 "CLOUD_RETAIL",
 "LOCAL_CLOUD_RETAIL",
@@ -518,6 +519,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -533,6 +535,7 @@ false
 "[Free product listings](https://support.google.com/merchants/answer/9199328).",
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
 "[Cloud retail](https://cloud.google.com/solutions/retail).",
 "[Local cloud retail](https://cloud.google.com/solutions/retail).",
diff --git a/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json
index 7a49a16e255..07142ac074a 100644
--- a/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json
+++ b/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json
@@ -298,7 +298,7 @@
 }
 }
 },
-"revision": "20241119",
+"revision": "20250203",
 "rootUrl": "https://merchantapi.googleapis.com/",
 "schemas": {
 "Empty": {
@@ -567,6 +567,7 @@
 "FREE_LISTINGS",
 "FREE_LOCAL_LISTINGS",
 "FREE_LOCAL_VEHICLE_LISTINGS",
+"YOUTUBE_AFFILIATE",
 "YOUTUBE_SHOPPING",
 "CLOUD_RETAIL",
 "LOCAL_CLOUD_RETAIL",
@@ -592,6 +593,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -607,6 +609,7 @@ false
 "[Free product listings](https://support.google.com/merchants/answer/9199328).",
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
 "[Cloud retail](https://cloud.google.com/solutions/retail).",
 "[Local cloud retail](https://cloud.google.com/solutions/retail).",
diff --git a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json
index 28a9455d64e..22e8c369e3f 100644
--- a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json
+++ b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json
@@ -262,7 +262,7 @@
 }
 }
 },
-"revision": "20241119",
+"revision": "20250203",
 "rootUrl": "https://merchantapi.googleapis.com/",
 "schemas": {
 "Empty": {
@@ -356,6 +356,7 @@
 "FREE_LISTINGS",
 "FREE_LOCAL_LISTINGS",
 "FREE_LOCAL_VEHICLE_LISTINGS",
+"YOUTUBE_AFFILIATE",
 "YOUTUBE_SHOPPING",
 "CLOUD_RETAIL",
 "LOCAL_CLOUD_RETAIL",
@@ -381,6 +382,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -396,6 +398,7 @@ false
 "[Free product listings](https://support.google.com/merchants/answer/9199328).",
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
 "[Cloud retail](https://cloud.google.com/solutions/retail).",
 "[Local cloud retail](https://cloud.google.com/solutions/retail).",
diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json
index c1e9b6a75de..66a7ab3a2bc 100644
--- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json
+++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json
@@ -149,7 +149,7 @@
 ],
 "parameters": {
 "dataSource": {
-"description": "Required. The primary or supplemental product data source name. If the product already exists and data source provided is different, then the product will be moved to a new data source. Format: `accounts/{account}/dataSources/{datasource}`.",
+"description": "Required. The primary or supplemental product data source name. If the product already exists and data source provided is different, then the product will be moved to a new data source. Only API data sources are supported. Format: `accounts/{account}/dataSources/{datasource}`.",
 "location": "query",
 "type": "string"
 },
@@ -242,7 +242,7 @@
 }
 }
 },
-"revision": "20250106",
+"revision": "20250208",
 "rootUrl": "https://merchantapi.googleapis.com/",
 "schemas": {
 "Attributes": {
@@ -829,6 +829,7 @@
 "FREE_LISTINGS",
 "FREE_LOCAL_LISTINGS",
 "FREE_LOCAL_VEHICLE_LISTINGS",
+"YOUTUBE_AFFILIATE",
 "YOUTUBE_SHOPPING",
 "CLOUD_RETAIL",
 "LOCAL_CLOUD_RETAIL",
@@ -854,6 +855,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -869,6 +871,7 @@ false
 "[Free product listings](https://support.google.com/merchants/answer/9199328).",
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
 "[Cloud retail](https://cloud.google.com/solutions/retail).",
 "[Local cloud retail](https://cloud.google.com/solutions/retail).",
@@ -989,6 +992,7 @@ false
 "FREE_LISTINGS",
 "FREE_LOCAL_LISTINGS",
 "FREE_LOCAL_VEHICLE_LISTINGS",
+"YOUTUBE_AFFILIATE",
 "YOUTUBE_SHOPPING",
 "CLOUD_RETAIL",
 "LOCAL_CLOUD_RETAIL",
@@ -1014,6 +1018,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -1029,6 +1034,7 @@ false
 "[Free product listings](https://support.google.com/merchants/answer/9199328).",
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
 "[Cloud retail](https://cloud.google.com/solutions/retail).",
 "[Local cloud retail](https://cloud.google.com/solutions/retail).",
@@ -1253,6 +1259,7 @@ false
 "FREE_LISTINGS",
 "FREE_LOCAL_LISTINGS",
 "FREE_LOCAL_VEHICLE_LISTINGS",
+"YOUTUBE_AFFILIATE",
 "YOUTUBE_SHOPPING",
 "CLOUD_RETAIL",
 "LOCAL_CLOUD_RETAIL",
@@ -1278,6 +1285,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -1293,6 +1301,7 @@ false
 "[Free product listings](https://support.google.com/merchants/answer/9199328).",
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
 "[Cloud retail](https://cloud.google.com/solutions/retail).",
 "[Local cloud retail](https://cloud.google.com/solutions/retail).",
diff --git a/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json
index 12f74a199e1..1a1a360c8f9 100644
--- a/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json
+++ b/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json
@@ -203,7 +203,7 @@
 }
 }
 },
-"revision": "20241119",
+"revision": "20250204",
 "rootUrl": "https://merchantapi.googleapis.com/",
 "schemas": {
 "Attributes": {
@@ -252,9 +252,9 @@
 "Free gift with description only.",
 "Free gift with monetary value.",
 "Free gift with item ID.",
-"Standard free shipping coupon value type.",
-"Overnight free shipping coupon value type.",
-"Two day free shipping coupon value type."
+"Standard free shipping coupon value type. Only available for online promotions.",
+"Overnight free shipping coupon value type. Only available for online promotions.",
+"Two day free shipping coupon value type. Only available for online promotions."
 ],
 "type": "string"
 },
@@ -407,11 +407,11 @@
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/12362804).",
 "Youtube shopping checkout.",
-"Youtube affiliate.",
-"Free vehicle listings.",
-"Vehicle ads.",
-"Cloud retail.",
-"Local cloud retail."
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
+"[Free vehicle listings](https://support.google.com/merchants/answer/11189169).",
+"[Vehicle ads](https://support.google.com/merchants/answer/11189169).",
+"[Cloud retail](https://cloud.google.com/solutions/retail).",
+"[Local cloud retail](https://cloud.google.com/solutions/retail)."
 ],
 "type": "string"
 },
@@ -501,6 +501,7 @@
 "FREE_LISTINGS",
 "FREE_LOCAL_LISTINGS",
 "FREE_LOCAL_VEHICLE_LISTINGS",
+"YOUTUBE_AFFILIATE",
 "YOUTUBE_SHOPPING",
 "CLOUD_RETAIL",
 "LOCAL_CLOUD_RETAIL",
@@ -526,6 +527,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -541,6 +543,7 @@ false
 "[Free product listings](https://support.google.com/merchants/answer/9199328).",
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
 "[Cloud retail](https://cloud.google.com/solutions/retail).",
 "[Local cloud retail](https://cloud.google.com/solutions/retail).",
@@ -661,6 +664,7 @@ false
 "FREE_LISTINGS",
 "FREE_LOCAL_LISTINGS",
 "FREE_LOCAL_VEHICLE_LISTINGS",
+"YOUTUBE_AFFILIATE",
 "YOUTUBE_SHOPPING",
 "CLOUD_RETAIL",
 "LOCAL_CLOUD_RETAIL",
@@ -686,6 +690,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -701,6 +706,7 @@ false
 "[Free product listings](https://support.google.com/merchants/answer/9199328).",
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
 "[Cloud retail](https://cloud.google.com/solutions/retail).",
 "[Local cloud retail](https://cloud.google.com/solutions/retail).",
@@ -801,6 +807,7 @@ false
 "FREE_LISTINGS",
 "FREE_LOCAL_LISTINGS",
 "FREE_LOCAL_VEHICLE_LISTINGS",
+"YOUTUBE_AFFILIATE",
 "YOUTUBE_SHOPPING",
 "CLOUD_RETAIL",
 "LOCAL_CLOUD_RETAIL",
@@ -826,6 +833,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -841,6 +849,7 @@ false
 "[Free product listings](https://support.google.com/merchants/answer/9199328).",
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
 "[Cloud retail](https://cloud.google.com/solutions/retail).",
 "[Local cloud retail](https://cloud.google.com/solutions/retail).",
diff --git a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json
index 033574a8bf5..ee335709b2f 100644
--- a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json
+++ b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json
@@ -150,7 +150,7 @@
 }
 }
 },
-"revision": "20241119",
+"revision": "20250203",
 "rootUrl": "https://merchantapi.googleapis.com/",
 "schemas": {
 "ListQuotaGroupsResponse": {
@@ -229,6 +229,7 @@
 "FREE_LISTINGS",
 "FREE_LOCAL_LISTINGS",
 "FREE_LOCAL_VEHICLE_LISTINGS",
+"YOUTUBE_AFFILIATE",
 "YOUTUBE_SHOPPING",
 "CLOUD_RETAIL",
 "LOCAL_CLOUD_RETAIL",
@@ -254,6 +255,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -269,6 +271,7 @@ false
 "[Free product listings](https://support.google.com/merchants/answer/9199328).",
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
 "[Cloud retail](https://cloud.google.com/solutions/retail).",
 "[Local cloud retail](https://cloud.google.com/solutions/retail).",
diff --git a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json
index 33e024df3dd..3dfe8bb8592 100644
--- a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json
+++ b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json
@@ -142,7 +142,7 @@
 }
 }
 },
-"revision": "20241119",
+"revision": "20250203",
 "rootUrl": "https://merchantapi.googleapis.com/",
 "schemas": {
 "BestSellersBrandView": {
@@ -650,6 +650,7 @@
 "FREE_LISTINGS",
 "FREE_LOCAL_LISTINGS",
 "FREE_LOCAL_VEHICLE_LISTINGS",
+"YOUTUBE_AFFILIATE",
 "YOUTUBE_SHOPPING",
 "CLOUD_RETAIL",
 "LOCAL_CLOUD_RETAIL",
@@ -675,6 +676,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -690,6 +692,7 @@ false
 "[Free product listings](https://support.google.com/merchants/answer/9199328).",
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
 "[Cloud retail](https://cloud.google.com/solutions/retail).",
 "[Local cloud retail](https://cloud.google.com/solutions/retail).",
@@ -1030,6 +1033,7 @@ false
 "FREE_LISTINGS",
 "FREE_LOCAL_LISTINGS",
 "FREE_LOCAL_VEHICLE_LISTINGS",
+"YOUTUBE_AFFILIATE",
 "YOUTUBE_SHOPPING",
 "CLOUD_RETAIL",
 "LOCAL_CLOUD_RETAIL",
@@ -1055,6 +1059,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -1070,6 +1075,7 @@ false
 "[Free product listings](https://support.google.com/merchants/answer/9199328).",
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
 "[Cloud retail](https://cloud.google.com/solutions/retail).",
 "[Local cloud retail](https://cloud.google.com/solutions/retail).",
diff --git a/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json
index 937fd4216ef..1d36c73b67a 100644
--- a/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json
+++ b/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json
@@ -356,7 +356,7 @@
 }
 }
 },
-"revision": "20241119",
+"revision": "20250204",
 "rootUrl": "https://merchantapi.googleapis.com/",
 "schemas": {
 "CustomAttribute": {
@@ -565,6 +565,7 @@
 "FREE_LISTINGS",
 "FREE_LOCAL_LISTINGS",
 "FREE_LOCAL_VEHICLE_LISTINGS",
+"YOUTUBE_AFFILIATE",
 "YOUTUBE_SHOPPING",
 "CLOUD_RETAIL",
 "LOCAL_CLOUD_RETAIL",
@@ -590,6 +591,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -605,6 +607,7 @@ false
 "[Free product listings](https://support.google.com/merchants/answer/9199328).",
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
 "[Cloud retail](https://cloud.google.com/solutions/retail).",
 "[Local cloud retail](https://cloud.google.com/solutions/retail).",
@@ -662,6 +665,7 @@ false
 "FREE_LISTINGS",
 "FREE_LOCAL_LISTINGS",
 "FREE_LOCAL_VEHICLE_LISTINGS",
+"YOUTUBE_AFFILIATE",
 "YOUTUBE_SHOPPING",
 "CLOUD_RETAIL",
 "LOCAL_CLOUD_RETAIL",
@@ -687,6 +691,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -702,6 +707,7 @@ false
 "[Free product listings](https://support.google.com/merchants/answer/9199328).",
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
 "[Cloud retail](https://cloud.google.com/solutions/retail).",
 "[Local cloud retail](https://cloud.google.com/solutions/retail).",
@@ -801,6 +807,7 @@ false
 "FREE_LISTINGS",
 "FREE_LOCAL_LISTINGS",
 "FREE_LOCAL_VEHICLE_LISTINGS",
+"YOUTUBE_AFFILIATE",
 "YOUTUBE_SHOPPING",
 "CLOUD_RETAIL",
 "LOCAL_CLOUD_RETAIL",
@@ -826,6 +833,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -841,6 +849,7 @@ false
 "[Free product listings](https://support.google.com/merchants/answer/9199328).",
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
 "[Cloud retail](https://cloud.google.com/solutions/retail).",
 "[Local cloud retail](https://cloud.google.com/solutions/retail).",
@@ -1075,6 +1084,7 @@ false
 "FREE_LISTINGS",
 "FREE_LOCAL_LISTINGS",
 "FREE_LOCAL_VEHICLE_LISTINGS",
+"YOUTUBE_AFFILIATE",
 "YOUTUBE_SHOPPING",
 "CLOUD_RETAIL",
 "LOCAL_CLOUD_RETAIL",
@@ -1100,6 +1110,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -1115,6 +1126,7 @@ false
 "[Free product listings](https://support.google.com/merchants/answer/9199328).",
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
 "[Cloud retail](https://cloud.google.com/solutions/retail).",
 "[Local cloud retail](https://cloud.google.com/solutions/retail).",
@@ -1172,6 +1184,7 @@ false
 "FREE_LISTINGS",
 "FREE_LOCAL_LISTINGS",
 "FREE_LOCAL_VEHICLE_LISTINGS",
+"YOUTUBE_AFFILIATE",
 "YOUTUBE_SHOPPING",
 "CLOUD_RETAIL",
 "LOCAL_CLOUD_RETAIL",
@@ -1197,6 +1210,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -1212,6 +1226,7 @@ false
 "[Free product listings](https://support.google.com/merchants/answer/9199328).",
 "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
 "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
+"[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
 "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
 "[Cloud retail](https://cloud.google.com/solutions/retail).",
 "[Local cloud retail](https://cloud.google.com/solutions/retail).",
diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json
index bfd473991aa..b57c7a5691a 100644
--- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json
@@ -589,7 +589,7 @@
 "vpcFlowLogsConfigs": {
 "methods": {
 "create": {
-"description": "Creates a new `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail. 2. The following fields are not considered as `settings` for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description ",
+"description": "Creates a new `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail 2. The following fields are not considered as `settings` for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description",
 "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/vpcFlowLogsConfigs",
 "httpMethod": "POST",
 "id": "networkmanagement.projects.locations.vpcFlowLogsConfigs.create",
@@ -718,7 +718,7 @@
 ]
 },
 "patch": {
-"description": "Updates an existing `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Updating a configuration with state=DISABLED will fail. 2. The following fields are not considered as `settings` for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description ",
+"description": "Creates a new `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail 2. The following fields are not considered as `settings` for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description",
 "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/vpcFlowLogsConfigs/{vpcFlowLogsConfigsId}",
 "httpMethod": "PATCH",
 "id": "networkmanagement.projects.locations.vpcFlowLogsConfigs.patch",
@@ -758,7 +758,7 @@
 }
 }
 },
-"revision": "20250108",
+"revision": "20250129",
 "rootUrl": "https://networkmanagement.googleapis.com/",
 "schemas": {
 "AbortInfo": {
diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json
index ac9e8114663..4a2a41f80e6 100644
--- a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json
@@ -4887,7 +4887,7 @@
 }
 }
 },
-"revision": "20250126",
+"revision": "20250202",
 "rootUrl": "https://networksecurity.googleapis.com/",
 "schemas": {
 "AddAddressGroupItemsRequest": {
@@ -5457,22 +5457,22 @@
 "type": "object"
 },
 "CustomInterceptProfile": {
-"description": "CustomInterceptProfile defines the Packet Intercept Endpoint Group used to intercept traffic to a third-party firewall in a Firewall rule.",
+"description": "CustomInterceptProfile defines in-band integration behavior (intercept). It is used by firewall rules with an APPLY_SECURITY_PROFILE_GROUP action.",
 "id": "CustomInterceptProfile",
 "properties": {
 "interceptEndpointGroup": {
-"description": "Required. The InterceptEndpointGroup to which traffic associated with the SP should be mirrored.",
+"description": "Required. The target InterceptEndpointGroup. When a firewall rule with this security profile attached matches a packet, the packet will be intercepted to the location-local target in this group.",
 "type": "string"
 }
 },
 "type": "object"
 },
 "CustomMirroringProfile": {
-"description": "CustomMirroringProfile defines an action for mirroring traffic to a collector's EndpointGroup",
+"description": "CustomMirroringProfile defines out-of-band integration behavior (mirroring). It is used by mirroring rules with a MIRROR action.",
 "id": "CustomMirroringProfile",
 "properties": {
 "mirroringEndpointGroup": {
-"description": "Required. The MirroringEndpointGroup to which traffic associated with the SP should be mirrored.",
+"description": "Required. The target MirroringEndpointGroup. When a mirroring rule with this security profile attached matches a packet, a replica will be mirrored to the location-local target in this group.",
 "type": "string"
 }
 },
diff --git a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json
index f1a9cc4be3a..b798474bcef 100644
--- a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json
+++ b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json
@@ -947,7 +947,7 @@
 }
 }
 },
-"revision": "20241128",
+"revision": "20250204",
 "rootUrl": "https://playdeveloperreporting.googleapis.com/",
 "schemas": {
 "GooglePlayDeveloperReportingV1alpha1Anomaly": {
@@ -1675,7 +1675,7 @@
 "description": "Specification of the timeline aggregation parameters. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the only supported timezone is `America/Los_Angeles`."
 },
 "userCohort": {
-"description": "User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta android versions only, excluding data from released android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., \"T1B2.220916.004\".",
+"description": "User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`.",
 "enum": [
 "USER_COHORT_UNSPECIFIED",
 "OS_PUBLIC",
@@ -1747,7 +1747,7 @@
 "description": "Specification of the timeline aggregation parameters. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the only supported timezone is `America/Los_Angeles`."
 },
 "userCohort": {
-"description": "User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta Android versions only, excluding data from released Android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., \"T1B2.220916.004\".",
+"description": "User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`.",
 "enum": [
 "USER_COHORT_UNSPECIFIED",
 "OS_PUBLIC",
@@ -1819,7 +1819,7 @@
 "description": "Specification of the timeline aggregation parameters. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the only supported timezone is `America/Los_Angeles`."
 },
 "userCohort": {
-"description": "User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta Android versions only, excluding data from released Android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., \"T1B2.220916.004\".",
+"description": "User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`.",
 "enum": [
 "USER_COHORT_UNSPECIFIED",
 "OS_PUBLIC",
@@ -1891,7 +1891,7 @@
 "description": "Specification of the timeline aggregation parameters. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the only supported timezone is `America/Los_Angeles`."
 },
 "userCohort": {
-"description": "User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta android versions only, excluding data from released android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., \"T1B2.220916.004\".",
+"description": "User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`.",
 "enum": [
 "USER_COHORT_UNSPECIFIED",
 "OS_PUBLIC",
diff --git a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json
index 66665995cba..a2c62daf02a 100644
--- a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json
@@ -947,7 +947,7 @@
 }
 }
 },
-"revision": "20241128",
+"revision": "20250204",
 "rootUrl": "https://playdeveloperreporting.googleapis.com/",
 "schemas": {
 "GooglePlayDeveloperReportingV1beta1Anomaly": {
@@ -1675,7 +1675,7 @@
 "description": "Specification of the timeline aggregation parameters. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the only supported timezone is `America/Los_Angeles`."
 },
 "userCohort": {
-"description": "User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta android versions only, excluding data from released android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., \"T1B2.220916.004\".",
+"description": "User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`.",
 "enum": [
 "USER_COHORT_UNSPECIFIED",
 "OS_PUBLIC",
@@ -1747,7 +1747,7 @@
 "description": "Specification of the timeline aggregation parameters. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the only supported timezone is `America/Los_Angeles`."
 },
 "userCohort": {
-"description": "User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta Android versions only, excluding data from released Android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., \"T1B2.220916.004\".",
+"description": "User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`.",
 "enum": [
 "USER_COHORT_UNSPECIFIED",
 "OS_PUBLIC",
@@ -1819,7 +1819,7 @@
 "description": "Specification of the timeline aggregation parameters. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the only supported timezone is `America/Los_Angeles`."
 },
 "userCohort": {
-"description": "User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta Android versions only, excluding data from released Android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., \"T1B2.220916.004\".",
+"description": "User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`.",
 "enum": [
 "USER_COHORT_UNSPECIFIED",
 "OS_PUBLIC",
@@ -1891,7 +1891,7 @@
 "description": "Specification of the timeline aggregation parameters. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the only supported timezone is `America/Los_Angeles`."
 },
 "userCohort": {
-"description": "User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta android versions only, excluding data from released android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., \"T1B2.220916.004\".",
+"description": "User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`.",
 "enum": [
 "USER_COHORT_UNSPECIFIED",
 "OS_PUBLIC",
diff --git a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json
index 64930e0d25e..5ecb359331f 100644
--- a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json
+++ b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json
@@ -12,7 +12,7 @@
 "baseUrl": "https://realtimebidding.googleapis.com/",
 "batchPath": "batch",
 "canonicalName": "Real-time Bidding",
-"description": "Allows external bidders to manage their RTB integration with Google. This includes managing bidder endpoints, QPS quotas, configuring what ad inventory to receive via pretargeting, submitting creatives for verification, and accessing creative metadata such as approval status.",
+"description": "Allows external bidders to manage their RTB integration with Google. This includes managing bidder endpoints, QPS quotas, configuring what ad inventory to receive with pretargeting, submitting creatives for verification, and accessing creative metadata such as approval status.",
 "discoveryVersion": "v1",
 "documentationLink": "https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/",
 "fullyEncodeReservedExpansion": true,
@@ -1305,7 +1305,7 @@
 }
 }
 },
-"revision": "20240930",
+"revision": "20250203",
 "rootUrl": "https://realtimebidding.googleapis.com/",
 "schemas": {
 "ActivatePretargetingConfigRequest": {
@@ -1529,7 +1529,7 @@
 "id": "Bidder",
 "properties": {
 "bypassNonguaranteedDealsPretargeting": {
-"description": "Output only. An option to bypass pretargeting for private auctions and preferred deals. When true, bid requests from these nonguaranteed deals will always be sent. When false, bid requests will be subject to regular pretargeting configurations. Programmatic Guaranteed deals will always be sent to the bidder, regardless of the value for this flag. Auction packages are not impacted by this value and are subject to the regular pretargeting configurations.",
+"description": "Output only. An option to bypass pretargeting for private auctions and preferred deals. When true, bid requests from these nonguaranteed deals will always be sent. When false, bid requests will be subject to regular pretargeting configurations. Programmatic Guaranteed deals will always be sent to the bidder, regardless of the value for this option. Auction packages are not impacted by this value and are subject to the regular pretargeting configurations.",
 "readOnly": true,
 "type": "boolean"
 },
diff --git a/googleapiclient/discovery_cache/documents/retail.v2.json b/googleapiclient/discovery_cache/documents/retail.v2.json
index 7303539ea82..7d9fd8529c5 100644
--- a/googleapiclient/discovery_cache/documents/retail.v2.json
+++ b/googleapiclient/discovery_cache/documents/retail.v2.json
@@ -2223,7 +2223,7 @@
 }
 }
 },
-"revision": "20250116",
+"revision": "20250130",
 "rootUrl": "https://retail.googleapis.com/",
 "schemas": {
 "GoogleApiHttpBody": {
@@ -5520,7 +5520,7 @@
 "id": "GoogleCloudRetailV2SearchRequestTileNavigationSpec",
 "properties": {
 "appliedTiles": {
-"description": "This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter.",
+"description": "This optional field specifies the tiles which are already clicked in client side. While the feature works without this field set, particularly for an initial query, it is highly recommended to set this field because it can improve the quality of the search response and removes possible duplicate tiles. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter.",
 "items": {
 "$ref": "GoogleCloudRetailV2Tile"
 },
diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json
index 4f82bfd9766..2e239893973 100644
--- a/googleapiclient/discovery_cache/documents/retail.v2alpha.json
+++ b/googleapiclient/discovery_cache/documents/retail.v2alpha.json
@@ -2744,7 +2744,7 @@
 }
 }
 },
-"revision": "20250116",
+"revision": "20250130",
 "rootUrl": "https://retail.googleapis.com/",
 "schemas": {
 "GoogleApiHttpBody": {
@@ -7391,7 +7391,7 @@
 "id": "GoogleCloudRetailV2alphaSearchRequestTileNavigationSpec",
 "properties": {
 "appliedTiles": {
-"description": "This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter.",
+"description": "This optional field specifies the tiles which are already clicked in client side. While the feature works without this field set, particularly for an initial query, it is highly recommended to set this field because it can improve the quality of the search response and removes possible duplicate tiles. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter.",
 "items": {
 "$ref": "GoogleCloudRetailV2alphaTile"
 },
diff --git a/googleapiclient/discovery_cache/documents/retail.v2beta.json b/googleapiclient/discovery_cache/documents/retail.v2beta.json
index 6aadb6151b8..d638ffdccee 100644
--- a/googleapiclient/discovery_cache/documents/retail.v2beta.json
+++ b/googleapiclient/discovery_cache/documents/retail.v2beta.json
@@ -2368,7 +2368,7 @@
 }
 }
 },
-"revision": "20250116",
+"revision": "20250130",
 "rootUrl": "https://retail.googleapis.com/",
 "schemas": {
 "GoogleApiHttpBody": {
@@ -7321,7 +7321,7 @@
 "id": "GoogleCloudRetailV2betaSearchRequestTileNavigationSpec",
 "properties": {
 "appliedTiles": {
-"description": "This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter.",
+"description": "This optional field specifies the tiles which are already clicked in client side. While the feature works without this field set, particularly for an initial query, it is highly recommended to set this field because it can improve the quality of the search response and removes possible duplicate tiles. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter.",
 "items": {
 "$ref": "GoogleCloudRetailV2betaTile"
 },
diff --git a/googleapiclient/discovery_cache/documents/script.v1.json b/googleapiclient/discovery_cache/documents/script.v1.json
index 7eeb96ddd6d..eba49e446df 100644
--- a/googleapiclient/discovery_cache/documents/script.v1.json
+++ b/googleapiclient/discovery_cache/documents/script.v1.json
@@ -851,7 +851,7 @@
 "scripts": {
 "methods": {
 "run": {
-"description": "Runs a function in an Apps Script project. The script project must be deployed for use with the Apps Script API and the calling application must share the same Cloud Platform project. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the [Authorization](#authorization-scopes) section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the script project **Overview** page and scroll down to \"Project OAuth Scopes.\" The error `403, PERMISSION_DENIED: The caller does not have permission` indicates that the Cloud Platform project used to authorize the request is not the same as the one used by the script.",
+"description": "",
 "flatPath": "v1/scripts/{scriptId}:run",
 "httpMethod": "POST",
 "id": "script.scripts.run",
@@ -891,7 +891,7 @@
 }
 }
 },
-"revision": "20240630",
+"revision": "20250130",
 "rootUrl": "https://script.googleapis.com/",
 "schemas": {
 "Content": {
diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1.json b/googleapiclient/discovery_cache/documents/videointelligence.v1.json
index acec478c2b7..fb60b9fb47e 100644
--- a/googleapiclient/discovery_cache/documents/videointelligence.v1.json
+++ b/googleapiclient/discovery_cache/documents/videointelligence.v1.json
@@ -114,7 +114,7 @@
 "operations": {
 "methods": {
 "cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
 "flatPath": "v1/operations/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
 "id": "videointelligence.operations.projects.locations.operations.cancel",
@@ -203,7 +203,7 @@
 "operations": {
 "methods": {
 "cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
 "id": "videointelligence.projects.locations.operations.cancel",
@@ -350,7 +350,7 @@
 }
 }
 },
-"revision": "20240704",
+"revision": "20250130",
 "rootUrl": "https://videointelligence.googleapis.com/",
 "schemas": {
 "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": {