diff --git a/docs/dyn/accessapproval_v1.folders.approvalRequests.html b/docs/dyn/accessapproval_v1.folders.approvalRequests.html index 7497c6ad004..2ebedc99fd0 100644 --- a/docs/dyn/accessapproval_v1.folders.approvalRequests.html +++ b/docs/dyn/accessapproval_v1.folders.approvalRequests.html @@ -137,6 +137,9 @@

Method Details

}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). + }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. @@ -199,6 +202,9 @@

Method Details

}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). + }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. @@ -250,6 +256,9 @@

Method Details

}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). + }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. @@ -307,6 +316,9 @@

Method Details

}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). + }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. @@ -363,6 +375,9 @@

Method Details

}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). + }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. diff --git a/docs/dyn/accessapproval_v1.organizations.approvalRequests.html b/docs/dyn/accessapproval_v1.organizations.approvalRequests.html index 0ae7d8617b2..b8c925c4ef0 100644 --- a/docs/dyn/accessapproval_v1.organizations.approvalRequests.html +++ b/docs/dyn/accessapproval_v1.organizations.approvalRequests.html @@ -137,6 +137,9 @@

Method Details

}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). + }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. @@ -199,6 +202,9 @@

Method Details

}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). + }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. @@ -250,6 +256,9 @@

Method Details

}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). + }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. @@ -307,6 +316,9 @@

Method Details

}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). + }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. @@ -363,6 +375,9 @@

Method Details

}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). + }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. diff --git a/docs/dyn/accessapproval_v1.projects.approvalRequests.html b/docs/dyn/accessapproval_v1.projects.approvalRequests.html index 0511152499b..da88f18c9ab 100644 --- a/docs/dyn/accessapproval_v1.projects.approvalRequests.html +++ b/docs/dyn/accessapproval_v1.projects.approvalRequests.html @@ -137,6 +137,9 @@

Method Details

}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). + }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. @@ -199,6 +202,9 @@

Method Details

}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). + }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. @@ -250,6 +256,9 @@

Method Details

}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). + }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. @@ -307,6 +316,9 @@

Method Details

}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). + }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. @@ -363,6 +375,9 @@

Method Details

}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). + }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. diff --git a/docs/dyn/analyticsadmin_v1alpha.accounts.html b/docs/dyn/analyticsadmin_v1alpha.accounts.html index 15cb1feda2f..7426ed8cbbc 100644 --- a/docs/dyn/analyticsadmin_v1alpha.accounts.html +++ b/docs/dyn/analyticsadmin_v1alpha.accounts.html @@ -706,7 +706,7 @@

Method Details

"freshDailyExportEnabled": True or False, # If set true, enables fresh daily export to the linked Google Cloud project. "includeAdvertisingId": True or False, # If set true, exported data will include advertising identifiers for mobile app streams. "name": "A String", # Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567' - "project": "A String", # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' + "project": "A String", # Immutable. The linked Google Cloud project resource name. Currently, this API always uses a project number, but may use project IDs in the future. Format: 'projects/{project number}' Example: 'projects/1234' "streamingExportEnabled": True or False, # If set true, enables streaming export to the linked Google Cloud project. }, "calculatedMetric": { # A definition for a calculated metric. # A snapshot of a CalculatedMetric resource in change history. @@ -1189,7 +1189,7 @@

Method Details

"freshDailyExportEnabled": True or False, # If set true, enables fresh daily export to the linked Google Cloud project. "includeAdvertisingId": True or False, # If set true, exported data will include advertising identifiers for mobile app streams. "name": "A String", # Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567' - "project": "A String", # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' + "project": "A String", # Immutable. The linked Google Cloud project resource name. Currently, this API always uses a project number, but may use project IDs in the future. Format: 'projects/{project number}' Example: 'projects/1234' "streamingExportEnabled": True or False, # If set true, enables streaming export to the linked Google Cloud project. }, "calculatedMetric": { # A definition for a calculated metric. # A snapshot of a CalculatedMetric resource in change history. diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.bigQueryLinks.html b/docs/dyn/analyticsadmin_v1alpha.properties.bigQueryLinks.html index 0cb727056cd..f271c30a3ed 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.bigQueryLinks.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.bigQueryLinks.html @@ -123,7 +123,7 @@

Method Details

"freshDailyExportEnabled": True or False, # If set true, enables fresh daily export to the linked Google Cloud project. "includeAdvertisingId": True or False, # If set true, exported data will include advertising identifiers for mobile app streams. "name": "A String", # Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567' - "project": "A String", # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' + "project": "A String", # Immutable. The linked Google Cloud project resource name. Currently, this API always uses a project number, but may use project IDs in the future. Format: 'projects/{project number}' Example: 'projects/1234' "streamingExportEnabled": True or False, # If set true, enables streaming export to the linked Google Cloud project. } @@ -148,7 +148,7 @@

Method Details

"freshDailyExportEnabled": True or False, # If set true, enables fresh daily export to the linked Google Cloud project. "includeAdvertisingId": True or False, # If set true, exported data will include advertising identifiers for mobile app streams. "name": "A String", # Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567' - "project": "A String", # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' + "project": "A String", # Immutable. The linked Google Cloud project resource name. Currently, this API always uses a project number, but may use project IDs in the future. Format: 'projects/{project number}' Example: 'projects/1234' "streamingExportEnabled": True or False, # If set true, enables streaming export to the linked Google Cloud project. } @@ -198,7 +198,7 @@

Method Details

"freshDailyExportEnabled": True or False, # If set true, enables fresh daily export to the linked Google Cloud project. "includeAdvertisingId": True or False, # If set true, exported data will include advertising identifiers for mobile app streams. "name": "A String", # Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567' - "project": "A String", # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' + "project": "A String", # Immutable. The linked Google Cloud project resource name. Currently, this API always uses a project number, but may use project IDs in the future. Format: 'projects/{project number}' Example: 'projects/1234' "streamingExportEnabled": True or False, # If set true, enables streaming export to the linked Google Cloud project. } @@ -234,7 +234,7 @@

Method Details

"freshDailyExportEnabled": True or False, # If set true, enables fresh daily export to the linked Google Cloud project. "includeAdvertisingId": True or False, # If set true, exported data will include advertising identifiers for mobile app streams. "name": "A String", # Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567' - "project": "A String", # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' + "project": "A String", # Immutable. The linked Google Cloud project resource name. Currently, this API always uses a project number, but may use project IDs in the future. Format: 'projects/{project number}' Example: 'projects/1234' "streamingExportEnabled": True or False, # If set true, enables streaming export to the linked Google Cloud project. }, ], @@ -278,7 +278,7 @@

Method Details

"freshDailyExportEnabled": True or False, # If set true, enables fresh daily export to the linked Google Cloud project. "includeAdvertisingId": True or False, # If set true, exported data will include advertising identifiers for mobile app streams. "name": "A String", # Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567' - "project": "A String", # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' + "project": "A String", # Immutable. The linked Google Cloud project resource name. Currently, this API always uses a project number, but may use project IDs in the future. Format: 'projects/{project number}' Example: 'projects/1234' "streamingExportEnabled": True or False, # If set true, enables streaming export to the linked Google Cloud project. } @@ -304,7 +304,7 @@

Method Details

"freshDailyExportEnabled": True or False, # If set true, enables fresh daily export to the linked Google Cloud project. "includeAdvertisingId": True or False, # If set true, exported data will include advertising identifiers for mobile app streams. "name": "A String", # Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567' - "project": "A String", # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' + "project": "A String", # Immutable. The linked Google Cloud project resource name. Currently, this API always uses a project number, but may use project IDs in the future. Format: 'projects/{project number}' Example: 'projects/1234' "streamingExportEnabled": True or False, # If set true, enables streaming export to the linked Google Cloud project. } diff --git a/docs/dyn/androidenterprise_v1.devices.html b/docs/dyn/androidenterprise_v1.devices.html index 1c3a92b7fd5..bfcb4b0419b 100644 --- a/docs/dyn/androidenterprise_v1.devices.html +++ b/docs/dyn/androidenterprise_v1.devices.html @@ -167,7 +167,7 @@

Method Details

"uri": "A String", # An authentication url. }, ], - "managedConfiguration": { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user. # The managed configuration for the product. + "managedConfiguration": { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations # The managed configuration for the product. "configurationVariables": { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user. "mcmId": "A String", # The ID of the managed configurations settings. "variableSet": [ # The variable set that is attributed to the user. @@ -309,7 +309,7 @@

Method Details

"uri": "A String", # An authentication url. }, ], - "managedConfiguration": { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user. # The managed configuration for the product. + "managedConfiguration": { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations # The managed configuration for the product. "configurationVariables": { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user. "mcmId": "A String", # The ID of the managed configurations settings. "variableSet": [ # The variable set that is attributed to the user. @@ -454,7 +454,7 @@

Method Details

"uri": "A String", # An authentication url. }, ], - "managedConfiguration": { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user. # The managed configuration for the product. + "managedConfiguration": { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations # The managed configuration for the product. "configurationVariables": { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user. "mcmId": "A String", # The ID of the managed configurations settings. "variableSet": [ # The variable set that is attributed to the user. @@ -566,7 +566,7 @@

Method Details

"uri": "A String", # An authentication url. }, ], - "managedConfiguration": { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user. # The managed configuration for the product. + "managedConfiguration": { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations # The managed configuration for the product. "configurationVariables": { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user. "mcmId": "A String", # The ID of the managed configurations settings. "variableSet": [ # The variable set that is attributed to the user. diff --git a/docs/dyn/androidenterprise_v1.enterprises.html b/docs/dyn/androidenterprise_v1.enterprises.html index ebe54ee5e91..3c3a228afc2 100644 --- a/docs/dyn/androidenterprise_v1.enterprises.html +++ b/docs/dyn/androidenterprise_v1.enterprises.html @@ -363,7 +363,7 @@

Method Details

An object of the form: { # A service account identity, including the name and credentials that can be used to authenticate as the service account. - "key": { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. Credentials that can be used to authenticate as a service account. # Credentials that can be used to authenticate as this ServiceAccount. + "key": { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations # Credentials that can be used to authenticate as this ServiceAccount. "data": "A String", # The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google. "id": "A String", # An opaque, unique identifier for this ServiceAccountKey. Assigned by the server. "publicData": "A String", # Public key data for the credentials file. This is an X.509 cert. If you are using the googleCredentials key type, this is identical to the cert that can be retrieved by using the X.509 cert url inside of the credentials file. diff --git a/docs/dyn/androidenterprise_v1.entitlements.html b/docs/dyn/androidenterprise_v1.entitlements.html index 7bf7d6ede87..41c01ae0f55 100644 --- a/docs/dyn/androidenterprise_v1.entitlements.html +++ b/docs/dyn/androidenterprise_v1.entitlements.html @@ -126,7 +126,7 @@

Method Details

Returns: An object of the form: - { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. The presence of an Entitlements resource indicates that a user has the right to use a particular app. Entitlements are user specific, not device specific. This allows a user with an entitlement to an app to install the app on all their devices. It's also possible for a user to hold an entitlement to an app without installing the app on any device. The API can be used to create an entitlement. As an option, you can also use the API to trigger the installation of an app on all a user's managed devices at the same time the entitlement is created. If the app is free, creating the entitlement also creates a group license for that app. For paid apps, creating the entitlement consumes one license, and that license remains consumed until the entitlement is removed. If the enterprise hasn't purchased enough licenses, then no entitlement is created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn't accepted. If an entitlement is deleted, the app may be uninstalled from a user's device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement. Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API. + { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. "productId": "A String", # The ID of the product that the entitlement is for. For example, "app:com.google.android.gm". "reason": "A String", # The reason for the entitlement. For example, "free" for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses. } @@ -149,7 +149,7 @@

Method Details

{ "entitlement": [ # An entitlement of a user to a product (e.g. an app). For example, a free app that they have installed, or a paid app that they have been allocated a license to. - { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. The presence of an Entitlements resource indicates that a user has the right to use a particular app. Entitlements are user specific, not device specific. This allows a user with an entitlement to an app to install the app on all their devices. It's also possible for a user to hold an entitlement to an app without installing the app on any device. The API can be used to create an entitlement. As an option, you can also use the API to trigger the installation of an app on all a user's managed devices at the same time the entitlement is created. If the app is free, creating the entitlement also creates a group license for that app. For paid apps, creating the entitlement consumes one license, and that license remains consumed until the entitlement is removed. If the enterprise hasn't purchased enough licenses, then no entitlement is created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn't accepted. If an entitlement is deleted, the app may be uninstalled from a user's device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement. Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API. + { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. "productId": "A String", # The ID of the product that the entitlement is for. For example, "app:com.google.android.gm". "reason": "A String", # The reason for the entitlement. For example, "free" for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses. }, @@ -168,7 +168,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. The presence of an Entitlements resource indicates that a user has the right to use a particular app. Entitlements are user specific, not device specific. This allows a user with an entitlement to an app to install the app on all their devices. It's also possible for a user to hold an entitlement to an app without installing the app on any device. The API can be used to create an entitlement. As an option, you can also use the API to trigger the installation of an app on all a user's managed devices at the same time the entitlement is created. If the app is free, creating the entitlement also creates a group license for that app. For paid apps, creating the entitlement consumes one license, and that license remains consumed until the entitlement is removed. If the enterprise hasn't purchased enough licenses, then no entitlement is created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn't accepted. If an entitlement is deleted, the app may be uninstalled from a user's device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement. Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API. +{ # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. "productId": "A String", # The ID of the product that the entitlement is for. For example, "app:com.google.android.gm". "reason": "A String", # The reason for the entitlement. For example, "free" for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses. } @@ -182,7 +182,7 @@

Method Details

Returns: An object of the form: - { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. The presence of an Entitlements resource indicates that a user has the right to use a particular app. Entitlements are user specific, not device specific. This allows a user with an entitlement to an app to install the app on all their devices. It's also possible for a user to hold an entitlement to an app without installing the app on any device. The API can be used to create an entitlement. As an option, you can also use the API to trigger the installation of an app on all a user's managed devices at the same time the entitlement is created. If the app is free, creating the entitlement also creates a group license for that app. For paid apps, creating the entitlement consumes one license, and that license remains consumed until the entitlement is removed. If the enterprise hasn't purchased enough licenses, then no entitlement is created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn't accepted. If an entitlement is deleted, the app may be uninstalled from a user's device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement. Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API. + { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. "productId": "A String", # The ID of the product that the entitlement is for. For example, "app:com.google.android.gm". "reason": "A String", # The reason for the entitlement. For example, "free" for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses. } diff --git a/docs/dyn/androidenterprise_v1.grouplicenses.html b/docs/dyn/androidenterprise_v1.grouplicenses.html index 17cd53c513b..cb547f0ad31 100644 --- a/docs/dyn/androidenterprise_v1.grouplicenses.html +++ b/docs/dyn/androidenterprise_v1.grouplicenses.html @@ -104,7 +104,7 @@

Method Details

Returns: An object of the form: - { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. Group license objects allow you to keep track of licenses (called entitlements) for both free and paid apps. For a free app, a group license is created when an enterprise admin first approves the product in Google Play or when the first entitlement for the product is created for a user via the API. For a paid app, a group license object is only created when an enterprise admin purchases the product in Google Play for the first time. Use the API to query group licenses. A Grouplicenses resource includes the total number of licenses purchased (paid apps only) and the total number of licenses currently in use. In other words, the total number of Entitlements that exist for the product. Only one group license object is created per product and group license objects are never deleted. If a product is unapproved, its group license remains. This allows enterprise admins to keep track of any remaining entitlements for the product. + { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations "acquisitionKind": "A String", # How this group license was acquired. "bulkPurchase" means that this Grouplicenses resource was created because the enterprise purchased licenses for this product; otherwise, the value is "free" (for free products). "approval": "A String", # Whether the product to which this group license relates is currently approved by the enterprise. Products are approved when a group license is first created, but this approval may be revoked by an enterprise admin via Google Play. Unapproved products will not be visible to end users in collections, and new entitlements to them should not normally be created. "numProvisioned": 42, # The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations. @@ -130,7 +130,7 @@

Method Details

{ "groupLicense": [ # A group license for a product approved for use in the enterprise. - { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. Group license objects allow you to keep track of licenses (called entitlements) for both free and paid apps. For a free app, a group license is created when an enterprise admin first approves the product in Google Play or when the first entitlement for the product is created for a user via the API. For a paid app, a group license object is only created when an enterprise admin purchases the product in Google Play for the first time. Use the API to query group licenses. A Grouplicenses resource includes the total number of licenses purchased (paid apps only) and the total number of licenses currently in use. In other words, the total number of Entitlements that exist for the product. Only one group license object is created per product and group license objects are never deleted. If a product is unapproved, its group license remains. This allows enterprise admins to keep track of any remaining entitlements for the product. + { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations "acquisitionKind": "A String", # How this group license was acquired. "bulkPurchase" means that this Grouplicenses resource was created because the enterprise purchased licenses for this product; otherwise, the value is "free" (for free products). "approval": "A String", # Whether the product to which this group license relates is currently approved by the enterprise. Products are approved when a group license is first created, but this approval may be revoked by an enterprise admin via Google Play. Unapproved products will not be visible to end users in collections, and new entitlements to them should not normally be created. "numProvisioned": 42, # The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations. diff --git a/docs/dyn/androidenterprise_v1.managedconfigurationsfordevice.html b/docs/dyn/androidenterprise_v1.managedconfigurationsfordevice.html index 50583832448..378c70af92b 100644 --- a/docs/dyn/androidenterprise_v1.managedconfigurationsfordevice.html +++ b/docs/dyn/androidenterprise_v1.managedconfigurationsfordevice.html @@ -128,7 +128,7 @@

Method Details

Returns: An object of the form: - { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user. + { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations "configurationVariables": { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user. "mcmId": "A String", # The ID of the managed configurations settings. "variableSet": [ # The variable set that is attributed to the user. @@ -184,7 +184,7 @@

Method Details

{ "managedConfigurationForDevice": [ # A managed configuration for an app on a specific device. - { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user. + { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations "configurationVariables": { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user. "mcmId": "A String", # The ID of the managed configurations settings. "variableSet": [ # The variable set that is attributed to the user. @@ -236,7 +236,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user. +{ # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations "configurationVariables": { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user. "mcmId": "A String", # The ID of the managed configurations settings. "variableSet": [ # The variable set that is attributed to the user. @@ -281,7 +281,7 @@

Method Details

Returns: An object of the form: - { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user. + { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations "configurationVariables": { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user. "mcmId": "A String", # The ID of the managed configurations settings. "variableSet": [ # The variable set that is attributed to the user. diff --git a/docs/dyn/androidenterprise_v1.managedconfigurationsforuser.html b/docs/dyn/androidenterprise_v1.managedconfigurationsforuser.html index 3463ee2e76a..d13ca8260ab 100644 --- a/docs/dyn/androidenterprise_v1.managedconfigurationsforuser.html +++ b/docs/dyn/androidenterprise_v1.managedconfigurationsforuser.html @@ -126,7 +126,7 @@

Method Details

Returns: An object of the form: - { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user. + { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations "configurationVariables": { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user. "mcmId": "A String", # The ID of the managed configurations settings. "variableSet": [ # The variable set that is attributed to the user. @@ -181,7 +181,7 @@

Method Details

{ "managedConfigurationForUser": [ # A managed configuration for an app for a specific user. - { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user. + { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations "configurationVariables": { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user. "mcmId": "A String", # The ID of the managed configurations settings. "variableSet": [ # The variable set that is attributed to the user. @@ -232,7 +232,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user. +{ # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations "configurationVariables": { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user. "mcmId": "A String", # The ID of the managed configurations settings. "variableSet": [ # The variable set that is attributed to the user. @@ -277,7 +277,7 @@

Method Details

Returns: An object of the form: - { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user. + { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations "configurationVariables": { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user. "mcmId": "A String", # The ID of the managed configurations settings. "variableSet": [ # The variable set that is attributed to the user. diff --git a/docs/dyn/androidenterprise_v1.serviceaccountkeys.html b/docs/dyn/androidenterprise_v1.serviceaccountkeys.html index 4007bb7e6d3..83674baf5cc 100644 --- a/docs/dyn/androidenterprise_v1.serviceaccountkeys.html +++ b/docs/dyn/androidenterprise_v1.serviceaccountkeys.html @@ -115,7 +115,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. Credentials that can be used to authenticate as a service account. +{ # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations "data": "A String", # The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google. "id": "A String", # An opaque, unique identifier for this ServiceAccountKey. Assigned by the server. "publicData": "A String", # Public key data for the credentials file. This is an X.509 cert. If you are using the googleCredentials key type, this is identical to the cert that can be retrieved by using the X.509 cert url inside of the credentials file. @@ -130,7 +130,7 @@

Method Details

Returns: An object of the form: - { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. Credentials that can be used to authenticate as a service account. + { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations "data": "A String", # The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google. "id": "A String", # An opaque, unique identifier for this ServiceAccountKey. Assigned by the server. "publicData": "A String", # Public key data for the credentials file. This is an X.509 cert. If you are using the googleCredentials key type, this is identical to the cert that can be retrieved by using the X.509 cert url inside of the credentials file. @@ -154,7 +154,7 @@

Method Details

{ "serviceAccountKey": [ # The service account credentials. - { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. Credentials that can be used to authenticate as a service account. + { # *Deprecated:* New integrations cannot use this method and can refer to our new recommendations "data": "A String", # The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google. "id": "A String", # An opaque, unique identifier for this ServiceAccountKey. Assigned by the server. "publicData": "A String", # Public key data for the credentials file. This is an X.509 cert. If you are using the googleCredentials key type, this is identical to the cert that can be retrieved by using the X.509 cert url inside of the credentials file. diff --git a/docs/dyn/androidmanagement_v1.enterprises.devices.html b/docs/dyn/androidmanagement_v1.enterprises.devices.html index c83ece1e240..bfdd1d439b1 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.devices.html +++ b/docs/dyn/androidmanagement_v1.enterprises.devices.html @@ -314,6 +314,7 @@

Method Details

"telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23. { # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23. "carrierName": "A String", # The carrier name associated with this SIM card. + "iccId": "A String", # Output only. The ICCID associated with this SIM card. "phoneNumber": "A String", # The phone number associated with this SIM card. }, ], @@ -679,6 +680,7 @@

Method Details

"telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23. { # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23. "carrierName": "A String", # The carrier name associated with this SIM card. + "iccId": "A String", # Output only. The ICCID associated with this SIM card. "phoneNumber": "A String", # The phone number associated with this SIM card. }, ], @@ -955,6 +957,7 @@

Method Details

"telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23. { # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23. "carrierName": "A String", # The carrier name associated with this SIM card. + "iccId": "A String", # Output only. The ICCID associated with this SIM card. "phoneNumber": "A String", # The phone number associated with this SIM card. }, ], @@ -1213,6 +1216,7 @@

Method Details

"telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23. { # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23. "carrierName": "A String", # The carrier name associated with this SIM card. + "iccId": "A String", # Output only. The ICCID associated with this SIM card. "phoneNumber": "A String", # The phone number associated with this SIM card. }, ], diff --git a/docs/dyn/androidpublisher_v3.edits.bundles.html b/docs/dyn/androidpublisher_v3.edits.bundles.html index 18bf263c336..8618ec47f99 100644 --- a/docs/dyn/androidpublisher_v3.edits.bundles.html +++ b/docs/dyn/androidpublisher_v3.edits.bundles.html @@ -123,7 +123,7 @@

Method Details

Args: packageName: string, Package name of the app. (required) editId: string, Identifier of the edit. (required) - ackBundleInstallationWarning: boolean, Must be set to true if the app bundle installation may trigger a warning on user devices (for example, if installation size may be over a threshold, typically 100 MB). + ackBundleInstallationWarning: boolean, Deprecated. The installation warning has been removed, it's not necessary to set this field anymore. deviceTierConfigId: string, Device tier config (DTC) to be used for generating deliverables (APKs). Contains id of the DTC or "LATEST" for last uploaded DTC. media_body: string, The filename of the media request body, or an instance of a MediaUpload object. media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. diff --git a/docs/dyn/androidpublisher_v3.externaltransactions.html b/docs/dyn/androidpublisher_v3.externaltransactions.html index 9bbb8ffa422..006fccb896d 100644 --- a/docs/dyn/androidpublisher_v3.externaltransactions.html +++ b/docs/dyn/androidpublisher_v3.externaltransactions.html @@ -111,6 +111,9 @@

Method Details

"currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. }, + "externalOfferInitialAcquisitionDetails": { # Details about the first time a user/device completed a transaction using external offers. # Optional. Details about the first time a user/device completed a transaction using external offers. Not required for transactions made using user choice billing or alternative billing only. + "externalTransactionId": "A String", # Required. The external transaction id of the first completed purchase made by the user. + }, "externalTransactionId": "A String", # Output only. The id of this transaction. All transaction ids under the same package name must be unique. Set when creating the external transaction. "oneTimeTransaction": { # Represents a one-time transaction. # This is a one-time transaction and not part of a subscription. "externalTransactionToken": "A String", # Input only. Provided during the call to Create. Retrieved from the client when the alternative billing flow is launched. @@ -164,6 +167,9 @@

Method Details

"currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. }, + "externalOfferInitialAcquisitionDetails": { # Details about the first time a user/device completed a transaction using external offers. # Optional. Details about the first time a user/device completed a transaction using external offers. Not required for transactions made using user choice billing or alternative billing only. + "externalTransactionId": "A String", # Required. The external transaction id of the first completed purchase made by the user. + }, "externalTransactionId": "A String", # Output only. The id of this transaction. All transaction ids under the same package name must be unique. Set when creating the external transaction. "oneTimeTransaction": { # Represents a one-time transaction. # This is a one-time transaction and not part of a subscription. "externalTransactionToken": "A String", # Input only. Provided during the call to Create. Retrieved from the client when the alternative billing flow is launched. @@ -223,6 +229,9 @@

Method Details

"currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. }, + "externalOfferInitialAcquisitionDetails": { # Details about the first time a user/device completed a transaction using external offers. # Optional. Details about the first time a user/device completed a transaction using external offers. Not required for transactions made using user choice billing or alternative billing only. + "externalTransactionId": "A String", # Required. The external transaction id of the first completed purchase made by the user. + }, "externalTransactionId": "A String", # Output only. The id of this transaction. All transaction ids under the same package name must be unique. Set when creating the external transaction. "oneTimeTransaction": { # Represents a one-time transaction. # This is a one-time transaction and not part of a subscription. "externalTransactionToken": "A String", # Input only. Provided during the call to Create. Retrieved from the client when the alternative billing flow is launched. @@ -298,6 +307,9 @@

Method Details

"currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. }, + "externalOfferInitialAcquisitionDetails": { # Details about the first time a user/device completed a transaction using external offers. # Optional. Details about the first time a user/device completed a transaction using external offers. Not required for transactions made using user choice billing or alternative billing only. + "externalTransactionId": "A String", # Required. The external transaction id of the first completed purchase made by the user. + }, "externalTransactionId": "A String", # Output only. The id of this transaction. All transaction ids under the same package name must be unique. Set when creating the external transaction. "oneTimeTransaction": { # Represents a one-time transaction. # This is a one-time transaction and not part of a subscription. "externalTransactionToken": "A String", # Input only. Provided during the call to Create. Retrieved from the client when the alternative billing flow is launched. diff --git a/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html b/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html index 9ab4cdb48c4..176f8fa60e7 100644 --- a/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html +++ b/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html @@ -236,6 +236,7 @@

Method Details

"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. @@ -378,6 +379,7 @@

Method Details

"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. @@ -460,6 +462,7 @@

Method Details

"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. @@ -566,6 +569,7 @@

Method Details

"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. @@ -637,6 +641,7 @@

Method Details

"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. @@ -707,6 +712,7 @@

Method Details

"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. diff --git a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.html b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.html index 69cba1d8679..dd1e962cf7e 100644 --- a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.html +++ b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.html @@ -261,6 +261,7 @@

Method Details

"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. @@ -446,6 +447,7 @@

Method Details

"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. @@ -553,6 +555,7 @@

Method Details

"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. @@ -665,6 +668,7 @@

Method Details

"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. @@ -760,6 +764,7 @@

Method Details

"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. }, + "partnerServicesBillingAccount": "A String", # Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} "resourceMonitoringEnabled": True or False, # Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. diff --git a/docs/dyn/backupdr_v1.projects.locations.backupVaults.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.html index 0c482735313..bcbf0fb9fe3 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.html @@ -134,7 +134,6 @@

Method Details

"deletable": True or False, # Output only. Set to true when there are no backups nested under this resource. "description": "A String", # Optional. The description of the BackupVault instance (2048 characters or less). "effectiveTime": "A String", # Optional. Time after which the BackupVault resource is locked. - "enforcedRetentionDuration": "A String", # Required. The default retention period for each backup in the backup vault (Deprecated). "etag": "A String", # Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other. "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined: "a_key": "A String", @@ -249,7 +248,6 @@

Method Details

"deletable": True or False, # Output only. Set to true when there are no backups nested under this resource. "description": "A String", # Optional. The description of the BackupVault instance (2048 characters or less). "effectiveTime": "A String", # Optional. Time after which the BackupVault resource is locked. - "enforcedRetentionDuration": "A String", # Required. The default retention period for each backup in the backup vault (Deprecated). "etag": "A String", # Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other. "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined: "a_key": "A String", @@ -307,7 +305,6 @@

Method Details

"deletable": True or False, # Output only. Set to true when there are no backups nested under this resource. "description": "A String", # Optional. The description of the BackupVault instance (2048 characters or less). "effectiveTime": "A String", # Optional. Time after which the BackupVault resource is locked. - "enforcedRetentionDuration": "A String", # Required. The default retention period for each backup in the backup vault (Deprecated). "etag": "A String", # Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other. "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined: "a_key": "A String", @@ -351,7 +348,6 @@

Method Details

"deletable": True or False, # Output only. Set to true when there are no backups nested under this resource. "description": "A String", # Optional. The description of the BackupVault instance (2048 characters or less). "effectiveTime": "A String", # Optional. Time after which the BackupVault resource is locked. - "enforcedRetentionDuration": "A String", # Required. The default retention period for each backup in the backup vault (Deprecated). "etag": "A String", # Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other. "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined: "a_key": "A String", @@ -404,7 +400,6 @@

Method Details

"deletable": True or False, # Output only. Set to true when there are no backups nested under this resource. "description": "A String", # Optional. The description of the BackupVault instance (2048 characters or less). "effectiveTime": "A String", # Optional. Time after which the BackupVault resource is locked. - "enforcedRetentionDuration": "A String", # Required. The default retention period for each backup in the backup vault (Deprecated). "etag": "A String", # Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other. "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined: "a_key": "A String", diff --git a/docs/dyn/batch_v1.projects.locations.jobs.html b/docs/dyn/batch_v1.projects.locations.jobs.html index 2cebe816e3c..fbfd39b2829 100644 --- a/docs/dyn/batch_v1.projects.locations.jobs.html +++ b/docs/dyn/batch_v1.projects.locations.jobs.html @@ -116,6 +116,7 @@

Method Details

"allocationPolicy": { # A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job. # Compute resource allocation for all TaskGroups in the Job. "instances": [ # Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now. { # InstancePolicyOrTemplate lets you define the type of resources to use for this job either with an InstancePolicy or an instance template. If undefined, Batch picks the type of VM to use and doesn't include optional VM resources such as GPUs and extra disks. + "blockProjectSshKeys": True or False, # Optional. Set this field to `true` if you want Batch to block project-level SSH keys from accessing this job's VMs. Alternatively, you can configure the job to specify a VM instance template that blocks project-level SSH keys. In either case, Batch blocks project-level SSH keys while creating the VMs for this job. Batch allows project-level SSH keys for a job's VMs only if all the following are true: + This field is undefined or set to `false`. + The job's VM instance template (if any) doesn't block project-level SSH keys. Notably, you can override this behavior by manually updating a VM to block or allow project-level SSH keys. For more information about blocking project-level SSH keys, see the Compute Engine documentation: https://cloud.google.com/compute/docs/connect/restrict-ssh-keys#block-keys "installGpuDrivers": True or False, # Set this field true if you want Batch to help fetch drivers from a third party location and install them for GPUs specified in `policy.accelerators` or `instance_template` on your behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py. "installOpsAgent": True or False, # Optional. Set this field true if you want Batch to install Ops Agent on your behalf. Default is false. "instanceTemplate": "A String", # Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict. @@ -385,6 +386,7 @@

Method Details

"allocationPolicy": { # A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job. # Compute resource allocation for all TaskGroups in the Job. "instances": [ # Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now. { # InstancePolicyOrTemplate lets you define the type of resources to use for this job either with an InstancePolicy or an instance template. If undefined, Batch picks the type of VM to use and doesn't include optional VM resources such as GPUs and extra disks. + "blockProjectSshKeys": True or False, # Optional. Set this field to `true` if you want Batch to block project-level SSH keys from accessing this job's VMs. Alternatively, you can configure the job to specify a VM instance template that blocks project-level SSH keys. In either case, Batch blocks project-level SSH keys while creating the VMs for this job. Batch allows project-level SSH keys for a job's VMs only if all the following are true: + This field is undefined or set to `false`. + The job's VM instance template (if any) doesn't block project-level SSH keys. Notably, you can override this behavior by manually updating a VM to block or allow project-level SSH keys. For more information about blocking project-level SSH keys, see the Compute Engine documentation: https://cloud.google.com/compute/docs/connect/restrict-ssh-keys#block-keys "installGpuDrivers": True or False, # Set this field true if you want Batch to help fetch drivers from a third party location and install them for GPUs specified in `policy.accelerators` or `instance_template` on your behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py. "installOpsAgent": True or False, # Optional. Set this field true if you want Batch to install Ops Agent on your behalf. Default is false. "instanceTemplate": "A String", # Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict. @@ -696,6 +698,7 @@

Method Details

"allocationPolicy": { # A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job. # Compute resource allocation for all TaskGroups in the Job. "instances": [ # Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now. { # InstancePolicyOrTemplate lets you define the type of resources to use for this job either with an InstancePolicy or an instance template. If undefined, Batch picks the type of VM to use and doesn't include optional VM resources such as GPUs and extra disks. + "blockProjectSshKeys": True or False, # Optional. Set this field to `true` if you want Batch to block project-level SSH keys from accessing this job's VMs. Alternatively, you can configure the job to specify a VM instance template that blocks project-level SSH keys. In either case, Batch blocks project-level SSH keys while creating the VMs for this job. Batch allows project-level SSH keys for a job's VMs only if all the following are true: + This field is undefined or set to `false`. + The job's VM instance template (if any) doesn't block project-level SSH keys. Notably, you can override this behavior by manually updating a VM to block or allow project-level SSH keys. For more information about blocking project-level SSH keys, see the Compute Engine documentation: https://cloud.google.com/compute/docs/connect/restrict-ssh-keys#block-keys "installGpuDrivers": True or False, # Set this field true if you want Batch to help fetch drivers from a third party location and install them for GPUs specified in `policy.accelerators` or `instance_template` on your behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py. "installOpsAgent": True or False, # Optional. Set this field true if you want Batch to install Ops Agent on your behalf. Default is false. "instanceTemplate": "A String", # Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict. @@ -976,6 +979,7 @@

Method Details

"allocationPolicy": { # A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job. # Compute resource allocation for all TaskGroups in the Job. "instances": [ # Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now. { # InstancePolicyOrTemplate lets you define the type of resources to use for this job either with an InstancePolicy or an instance template. If undefined, Batch picks the type of VM to use and doesn't include optional VM resources such as GPUs and extra disks. + "blockProjectSshKeys": True or False, # Optional. Set this field to `true` if you want Batch to block project-level SSH keys from accessing this job's VMs. Alternatively, you can configure the job to specify a VM instance template that blocks project-level SSH keys. In either case, Batch blocks project-level SSH keys while creating the VMs for this job. Batch allows project-level SSH keys for a job's VMs only if all the following are true: + This field is undefined or set to `false`. + The job's VM instance template (if any) doesn't block project-level SSH keys. Notably, you can override this behavior by manually updating a VM to block or allow project-level SSH keys. For more information about blocking project-level SSH keys, see the Compute Engine documentation: https://cloud.google.com/compute/docs/connect/restrict-ssh-keys#block-keys "installGpuDrivers": True or False, # Set this field true if you want Batch to help fetch drivers from a third party location and install them for GPUs specified in `policy.accelerators` or `instance_template` on your behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py. "installOpsAgent": True or False, # Optional. Set this field true if you want Batch to install Ops Agent on your behalf. Default is false. "instanceTemplate": "A String", # Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict. diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index 29a5d223f2a..ca6bff938dd 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -286,7 +286,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -395,7 +395,7 @@

Method Details

}, "systemVariables": { # System variables given to a query. # Output only. System variables for GoogleSQL queries. A system variable is output if the variable is settable and its value differs from the system default. "@@" prefix is not included in the name of the System variables. "types": { # Output only. Data type for each system variable. - "a_key": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } + "a_key": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY". "rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE". "structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT". @@ -518,7 +518,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -550,7 +550,7 @@

Method Details

}, "etag": "A String", # Output only. A hash of this resource. "id": "A String", # Output only. Opaque ID field of the job. - "jobCreationReason": { # Reason about why a Job was created from a [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`. This feature is not yet available. Jobs will always be created. # Output only. If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created. + "jobCreationReason": { # Reason about why a Job was created from a [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`. [Preview](/products/#product-launch-stages) # Output only. The reason why a Job was created. [Preview](/products/#product-launch-stages) "code": "A String", # Output only. Specifies the high level reason why a Job was created. }, "jobReference": { # A job reference is a fully qualified identifier for referring to a job. # Optional. Reference describing the unique-per-user name of the job. @@ -1343,7 +1343,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -1700,7 +1700,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -1809,7 +1809,7 @@

Method Details

}, "systemVariables": { # System variables given to a query. # Output only. System variables for GoogleSQL queries. A system variable is output if the variable is settable and its value differs from the system default. "@@" prefix is not included in the name of the System variables. "types": { # Output only. Data type for each system variable. - "a_key": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } + "a_key": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY". "rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE". "structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT". @@ -1932,7 +1932,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -1964,7 +1964,7 @@

Method Details

}, "etag": "A String", # Output only. A hash of this resource. "id": "A String", # Output only. Opaque ID field of the job. - "jobCreationReason": { # Reason about why a Job was created from a [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`. This feature is not yet available. Jobs will always be created. # Output only. If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created. + "jobCreationReason": { # Reason about why a Job was created from a [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`. [Preview](/products/#product-launch-stages) # Output only. The reason why a Job was created. [Preview](/products/#product-launch-stages) "code": "A String", # Output only. Specifies the high level reason why a Job was created. }, "jobReference": { # A job reference is a fully qualified identifier for referring to a job. # Optional. Reference describing the unique-per-user name of the job. @@ -2757,7 +2757,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -2996,7 +2996,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -3195,7 +3195,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -3304,7 +3304,7 @@

Method Details

}, "systemVariables": { # System variables given to a query. # Output only. System variables for GoogleSQL queries. A system variable is output if the variable is settable and its value differs from the system default. "@@" prefix is not included in the name of the System variables. "types": { # Output only. Data type for each system variable. - "a_key": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } + "a_key": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY". "rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE". "structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT". @@ -3427,7 +3427,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -3459,7 +3459,7 @@

Method Details

}, "etag": "A String", # Output only. A hash of this resource. "id": "A String", # Output only. Opaque ID field of the job. - "jobCreationReason": { # Reason about why a Job was created from a [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`. This feature is not yet available. Jobs will always be created. # Output only. If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created. + "jobCreationReason": { # Reason about why a Job was created from a [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`. [Preview](/products/#product-launch-stages) # Output only. The reason why a Job was created. [Preview](/products/#product-launch-stages) "code": "A String", # Output only. Specifies the high level reason why a Job was created. }, "jobReference": { # A job reference is a fully qualified identifier for referring to a job. # Optional. Reference describing the unique-per-user name of the job. @@ -4252,7 +4252,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -4580,7 +4580,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -4689,7 +4689,7 @@

Method Details

}, "systemVariables": { # System variables given to a query. # Output only. System variables for GoogleSQL queries. A system variable is output if the variable is settable and its value differs from the system default. "@@" prefix is not included in the name of the System variables. "types": { # Output only. Data type for each system variable. - "a_key": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } + "a_key": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY". "rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE". "structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT". @@ -4812,7 +4812,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -4844,7 +4844,7 @@

Method Details

}, "etag": "A String", # Output only. A hash of this resource. "id": "A String", # Output only. Opaque ID field of the job. - "jobCreationReason": { # Reason about why a Job was created from a [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`. This feature is not yet available. Jobs will always be created. # Output only. If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created. + "jobCreationReason": { # Reason about why a Job was created from a [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`. [Preview](/products/#product-launch-stages) # Output only. The reason why a Job was created. [Preview](/products/#product-launch-stages) "code": "A String", # Output only. Specifies the high level reason why a Job was created. }, "jobReference": { # A job reference is a fully qualified identifier for referring to a job. # Optional. Reference describing the unique-per-user name of the job. @@ -5637,7 +5637,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -5988,7 +5988,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -6097,7 +6097,7 @@

Method Details

}, "systemVariables": { # System variables given to a query. # Output only. System variables for GoogleSQL queries. A system variable is output if the variable is settable and its value differs from the system default. "@@" prefix is not included in the name of the System variables. "types": { # Output only. Data type for each system variable. - "a_key": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } + "a_key": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY". "rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE". "structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT". @@ -6220,7 +6220,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -7047,7 +7047,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -7249,7 +7249,7 @@

Method Details

"formatOptions": { # Options for data format adjustments. # Optional. Output format adjustments. "useInt64Timestamp": True or False, # Optional. Output timestamp as usec int64. Default is false. }, - "jobCreationMode": "A String", # Optional. If not set, jobs are always required. If set, the query request will follow the behavior described JobCreationMode. This feature is not yet available. Jobs will always be created. + "jobCreationMode": "A String", # Optional. If not set, jobs are always required. If set, the query request will follow the behavior described JobCreationMode. [Preview](/products/#product-launch-stages) "kind": "bigquery#queryRequest", # The resource type of the request. "labels": { # Optional. The labels associated with this query. Labels can be used to organize and group query jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label keys must start with a letter and each label in the list must have a different key. "a_key": "A String", @@ -7320,10 +7320,10 @@

Method Details

}, ], "jobComplete": True or False, # Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available. - "jobCreationReason": { # Reason about why a Job was created from a [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`. This feature is not yet available. Jobs will always be created. # Optional. Only relevant when a job_reference is present in the response. If job_reference is not present it will always be unset. When job_reference is present, this field should be interpreted as follows: If set, it will provide the reason of why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created. + "jobCreationReason": { # Reason about why a Job was created from a [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`. [Preview](/products/#product-launch-stages) # Optional. The reason why a Job was created. Only relevant when a job_reference is present in the response. If job_reference is not present it will always be unset. [Preview](/products/#product-launch-stages) "code": "A String", # Output only. Specifies the high level reason why a Job was created. }, - "jobReference": { # A job reference is a fully qualified identifier for referring to a job. # Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults). + "jobReference": { # A job reference is a fully qualified identifier for referring to a job. # Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults). If job_creation_mode was set to `JOB_CREATION_OPTIONAL` and the query completes without creating a job, this field will be empty. "jobId": "A String", # Required. The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. "location": "A String", # Optional. The geographic location of the job. The default value is US. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations "projectId": "A String", # Required. The ID of the project containing this job. @@ -7331,7 +7331,7 @@

Method Details

"kind": "bigquery#queryResponse", # The resource type. "numDmlAffectedRows": "A String", # Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. "pageToken": "A String", # A token used for paging results. A non-empty token indicates that additional results are available. To see additional results, query the [`jobs.getQueryResults`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/getQueryResults) method. For more information, see [Paging through table data](https://cloud.google.com/bigquery/docs/paging-results). - "queryId": "A String", # Query ID for the completed query. This ID will be auto-generated. This field is not yet available and it is currently not guaranteed to be populated. + "queryId": "A String", # Auto-generated ID for the query. [Preview](/products/#product-launch-stages) "rows": [ # An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. { "f": [ # Represents a single row in the result set, consisting of one or more fields. @@ -7375,7 +7375,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). diff --git a/docs/dyn/bigquery_v2.models.html b/docs/dyn/bigquery_v2.models.html index 8f64f289d93..f6ffbcc32f7 100644 --- a/docs/dyn/bigquery_v2.models.html +++ b/docs/dyn/bigquery_v2.models.html @@ -1156,7 +1156,7 @@

Method Details

{ # Information about a single transform column. "name": "A String", # Output only. Name of the column. "transformSql": "A String", # Output only. The SQL expression used in the column transform. - "type": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } # Output only. Data type of the column after the transform. + "type": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } # Output only. Data type of the column after the transform. "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY". "rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE". "structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT". @@ -2220,7 +2220,7 @@

Method Details

{ # Information about a single transform column. "name": "A String", # Output only. Name of the column. "transformSql": "A String", # Output only. The SQL expression used in the column transform. - "type": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } # Output only. Data type of the column after the transform. + "type": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } # Output only. Data type of the column after the transform. "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY". "rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE". "structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT". @@ -3293,7 +3293,7 @@

Method Details

{ # Information about a single transform column. "name": "A String", # Output only. Name of the column. "transformSql": "A String", # Output only. The SQL expression used in the column transform. - "type": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } # Output only. Data type of the column after the transform. + "type": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } # Output only. Data type of the column after the transform. "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY". "rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE". "structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT". @@ -4345,7 +4345,7 @@

Method Details

{ # Information about a single transform column. "name": "A String", # Output only. Name of the column. "transformSql": "A String", # Output only. The SQL expression used in the column transform. - "type": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } # Output only. Data type of the column after the transform. + "type": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } # Output only. Data type of the column after the transform. "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY". "rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE". "structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT". diff --git a/docs/dyn/bigquery_v2.routines.html b/docs/dyn/bigquery_v2.routines.html index ae751692fbc..dc7a599a3b4 100644 --- a/docs/dyn/bigquery_v2.routines.html +++ b/docs/dyn/bigquery_v2.routines.html @@ -143,7 +143,7 @@

Method Details

"arguments": [ # Optional. { # Input/output argument of a function or a stored procedure. "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE. - "dataType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } # Required unless argument_kind = ANY_TYPE. + "dataType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } # Required unless argument_kind = ANY_TYPE. "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY". "rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE". "structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT". @@ -188,7 +188,7 @@

Method Details

}, ], }, - "returnType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } # Optional if language = "SQL"; required otherwise. Cannot be set if routine_type = "TABLE_VALUED_FUNCTION". If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time. For example, for the functions created with the following statements: * `CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);` * `CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));` * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));` The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and is absent for `Increment` (inferred as FLOAT64 at query time). Suppose the function `Add` is replaced by `CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);` Then the inferred return type of `Increment` is automatically changed to INT64 at query time, while the return type of `Decrement` remains FLOAT64. + "returnType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } # Optional if language = "SQL"; required otherwise. Cannot be set if routine_type = "TABLE_VALUED_FUNCTION". If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time. For example, for the functions created with the following statements: * `CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);` * `CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));` * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));` The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and is absent for `Increment` (inferred as FLOAT64 at query time). Suppose the function `Add` is replaced by `CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);` Then the inferred return type of `Increment` is automatically changed to INT64 at query time, while the return type of `Decrement` remains FLOAT64. "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY". "rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE". "structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT". @@ -304,7 +304,7 @@

Method Details

"arguments": [ # Optional. { # Input/output argument of a function or a stored procedure. "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE. - "dataType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } # Required unless argument_kind = ANY_TYPE. + "dataType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } # Required unless argument_kind = ANY_TYPE. "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY". "rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE". "structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT". @@ -349,7 +349,7 @@

Method Details

}, ], }, - "returnType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } # Optional if language = "SQL"; required otherwise. Cannot be set if routine_type = "TABLE_VALUED_FUNCTION". If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time. For example, for the functions created with the following statements: * `CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);` * `CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));` * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));` The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and is absent for `Increment` (inferred as FLOAT64 at query time). Suppose the function `Add` is replaced by `CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);` Then the inferred return type of `Increment` is automatically changed to INT64 at query time, while the return type of `Decrement` remains FLOAT64. + "returnType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } # Optional if language = "SQL"; required otherwise. Cannot be set if routine_type = "TABLE_VALUED_FUNCTION". If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time. For example, for the functions created with the following statements: * `CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);` * `CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));` * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));` The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and is absent for `Increment` (inferred as FLOAT64 at query time). Suppose the function `Add` is replaced by `CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);` Then the inferred return type of `Increment` is automatically changed to INT64 at query time, while the return type of `Decrement` remains FLOAT64. "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY". "rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE". "structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT". @@ -406,7 +406,7 @@

Method Details

"arguments": [ # Optional. { # Input/output argument of a function or a stored procedure. "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE. - "dataType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } # Required unless argument_kind = ANY_TYPE. + "dataType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } # Required unless argument_kind = ANY_TYPE. "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY". "rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE". "structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT". @@ -451,7 +451,7 @@

Method Details

}, ], }, - "returnType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } # Optional if language = "SQL"; required otherwise. Cannot be set if routine_type = "TABLE_VALUED_FUNCTION". If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time. For example, for the functions created with the following statements: * `CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);` * `CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));` * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));` The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and is absent for `Increment` (inferred as FLOAT64 at query time). Suppose the function `Add` is replaced by `CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);` Then the inferred return type of `Increment` is automatically changed to INT64 at query time, while the return type of `Decrement` remains FLOAT64. + "returnType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } # Optional if language = "SQL"; required otherwise. Cannot be set if routine_type = "TABLE_VALUED_FUNCTION". If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time. For example, for the functions created with the following statements: * `CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);` * `CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));` * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));` The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and is absent for `Increment` (inferred as FLOAT64 at query time). Suppose the function `Add` is replaced by `CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);` Then the inferred return type of `Increment` is automatically changed to INT64 at query time, while the return type of `Decrement` remains FLOAT64. "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY". "rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE". "structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT". @@ -523,7 +523,7 @@

Method Details

"arguments": [ # Optional. { # Input/output argument of a function or a stored procedure. "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE. - "dataType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } # Required unless argument_kind = ANY_TYPE. + "dataType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } # Required unless argument_kind = ANY_TYPE. "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY". "rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE". "structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT". @@ -568,7 +568,7 @@

Method Details

}, ], }, - "returnType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } # Optional if language = "SQL"; required otherwise. Cannot be set if routine_type = "TABLE_VALUED_FUNCTION". If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time. For example, for the functions created with the following statements: * `CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);` * `CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));` * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));` The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and is absent for `Increment` (inferred as FLOAT64 at query time). Suppose the function `Add` is replaced by `CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);` Then the inferred return type of `Increment` is automatically changed to INT64 at query time, while the return type of `Decrement` remains FLOAT64. + "returnType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } # Optional if language = "SQL"; required otherwise. Cannot be set if routine_type = "TABLE_VALUED_FUNCTION". If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time. For example, for the functions created with the following statements: * `CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);` * `CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));` * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));` The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and is absent for `Increment` (inferred as FLOAT64 at query time). Suppose the function `Add` is replaced by `CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);` Then the inferred return type of `Increment` is automatically changed to INT64 at query time, while the return type of `Decrement` remains FLOAT64. "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY". "rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE". "structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT". @@ -730,7 +730,7 @@

Method Details

"arguments": [ # Optional. { # Input/output argument of a function or a stored procedure. "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE. - "dataType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } # Required unless argument_kind = ANY_TYPE. + "dataType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } # Required unless argument_kind = ANY_TYPE. "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY". "rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE". "structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT". @@ -775,7 +775,7 @@

Method Details

}, ], }, - "returnType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } # Optional if language = "SQL"; required otherwise. Cannot be set if routine_type = "TABLE_VALUED_FUNCTION". If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time. For example, for the functions created with the following statements: * `CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);` * `CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));` * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));` The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and is absent for `Increment` (inferred as FLOAT64 at query time). Suppose the function `Add` is replaced by `CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);` Then the inferred return type of `Increment` is automatically changed to INT64 at query time, while the return type of `Decrement` remains FLOAT64. + "returnType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } # Optional if language = "SQL"; required otherwise. Cannot be set if routine_type = "TABLE_VALUED_FUNCTION". If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time. For example, for the functions created with the following statements: * `CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);` * `CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));` * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));` The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and is absent for `Increment` (inferred as FLOAT64 at query time). Suppose the function `Add` is replaced by `CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);` Then the inferred return type of `Increment` is automatically changed to INT64 at query time, while the return type of `Decrement` remains FLOAT64. "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY". "rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE". "structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT". @@ -832,7 +832,7 @@

Method Details

"arguments": [ # Optional. { # Input/output argument of a function or a stored procedure. "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE. - "dataType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } # Required unless argument_kind = ANY_TYPE. + "dataType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } # Required unless argument_kind = ANY_TYPE. "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY". "rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE". "structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT". @@ -877,7 +877,7 @@

Method Details

}, ], }, - "returnType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } # Optional if language = "SQL"; required otherwise. Cannot be set if routine_type = "TABLE_VALUED_FUNCTION". If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time. For example, for the functions created with the following statements: * `CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);` * `CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));` * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));` The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and is absent for `Increment` (inferred as FLOAT64 at query time). Suppose the function `Add` is replaced by `CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);` Then the inferred return type of `Increment` is automatically changed to INT64 at query time, while the return type of `Decrement` remains FLOAT64. + "returnType": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } # Optional if language = "SQL"; required otherwise. Cannot be set if routine_type = "TABLE_VALUED_FUNCTION". If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time. For example, for the functions created with the following statements: * `CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);` * `CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));` * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));` The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and is absent for `Increment` (inferred as FLOAT64 at query time). Suppose the function `Add` is replaced by `CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);` Then the inferred return type of `Increment` is automatically changed to INT64 at query time, while the return type of `Decrement` remains FLOAT64. "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY". "rangeElementType": # Object with schema name: StandardSqlDataType # The type of the range's elements, if type_kind = "RANGE". "structType": { # The representation of a SQL STRUCT type. # The fields of this struct, in order, if type_kind = "STRUCT". diff --git a/docs/dyn/bigquery_v2.tables.html b/docs/dyn/bigquery_v2.tables.html index 78bc41bedc2..d379174309e 100644 --- a/docs/dyn/bigquery_v2.tables.html +++ b/docs/dyn/bigquery_v2.tables.html @@ -302,7 +302,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -451,7 +451,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -784,7 +784,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -933,7 +933,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -1207,7 +1207,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -1356,7 +1356,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -1738,7 +1738,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -1887,7 +1887,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -2162,7 +2162,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -2311,7 +2311,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -2704,7 +2704,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -2853,7 +2853,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -3128,7 +3128,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). @@ -3277,7 +3277,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. - "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. + "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], "foreignTypeInfo": { # Metadata about the foreign data type definition such as the system in which the type is defined. # Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). diff --git a/docs/dyn/chat_v1.spaces.html b/docs/dyn/chat_v1.spaces.html index 4b2bc501b9e..f094d9775cf 100644 --- a/docs/dyn/chat_v1.spaces.html +++ b/docs/dyn/chat_v1.spaces.html @@ -99,13 +99,13 @@

Instance Methods

create(body=None, requestId=None, x__xgafv=None)

Creates a named space. Spaces grouped by topics aren't supported. For an example, see [Create a space](https://developers.google.com/workspace/chat/create-spaces). If you receive the error message `ALREADY_EXISTS` when creating a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

- delete(name, x__xgafv=None)

+ delete(name, useAdminAccess=None, x__xgafv=None)

Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see [Delete a space](https://developers.google.com/workspace/chat/delete-spaces). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) from a user who has permission to delete the space.

findDirectMessage(name=None, x__xgafv=None)

Returns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). With [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), returns the direct message space between the specified user and the authenticated user. With [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), returns the direct message space between the specified user and the calling Chat app. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) or [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).

- get(name, x__xgafv=None)

+ get(name, useAdminAccess=None, x__xgafv=None)

Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

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

@@ -114,8 +114,14 @@

Instance Methods

list_next()

Retrieves the next page of results.

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

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

Updates a space. For an example, see [Update a space](https://developers.google.com/workspace/chat/update-spaces). If you're updating the `displayName` field and receive the error message `ALREADY_EXISTS`, try a different display name.. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

+

+ search(orderBy=None, pageSize=None, pageToken=None, query=None, useAdminAccess=None, x__xgafv=None)

+

[Developer Preview](https://developers.google.com/workspace/preview). Returns a list of spaces based on a user's search. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). The user must be an administrator for the Google Workspace organization. In the request, set `use_admin_access` to `true`.

+

+ search_next()

+

Retrieves the next page of results.

setup(body=None, x__xgafv=None)

Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see [Set up a space with initial members](https://developers.google.com/workspace/chat/set-up-spaces). To specify the human members to add, add memberships with the appropriate `membership.member.name`. To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. To specify the Google groups to add, add memberships with the appropriate `membership.group_member.name`. To add or invite a Google group, use `groups/{group}`, where `{group}` is the `id` for the group from the Cloud Identity Groups API. For example, you can use [Cloud Identity Groups lookup API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup) to retrieve the ID `123456789` for group email `group@example.com`, then you can add the group to the space by setting the `membership.group_member.name` to `groups/123456789`. Group email is not supported, and Google groups can only be added as members in named spaces. For a named space or group chat, if the caller blocks, or is blocked by some members, or doesn't have permission to add some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to `true` and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see [Invite or add a user or app to a space](https://developers.google.com/workspace/chat/create-members). If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

@@ -156,6 +162,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -190,6 +201,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -223,6 +239,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -239,11 +260,12 @@

Method Details

- delete(name, x__xgafv=None) + delete(name, useAdminAccess=None, x__xgafv=None)
Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see [Delete a space](https://developers.google.com/workspace/chat/delete-spaces). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) from a user who has permission to delete the space.
 
 Args:
   name: string, Required. Resource name of the space to delete. Format: `spaces/{space}` (required)
+  useAdminAccess: boolean, [Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.delete` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -280,6 +302,11 @@ 

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -296,11 +323,12 @@

Method Details

- get(name, x__xgafv=None) + get(name, useAdminAccess=None, x__xgafv=None)
Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
 
 Args:
   name: string, Required. Resource name of the space, in the form `spaces/{space}`. Format: `spaces/{space}` (required)
+  useAdminAccess: boolean, [Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` or `chat.admin.spaces.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -319,6 +347,11 @@ 

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -363,6 +396,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -395,7 +433,7 @@

Method Details

- patch(name, body=None, updateMask=None, x__xgafv=None) + patch(name, body=None, updateMask=None, useAdminAccess=None, x__xgafv=None)
Updates a space. For an example, see [Update a space](https://developers.google.com/workspace/chat/update-spaces). If you're updating the `displayName` field and receive the error message `ALREADY_EXISTS`, try a different display name.. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
 
 Args:
@@ -413,6 +451,11 @@ 

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -428,6 +471,7 @@

Method Details

} updateMask: string, Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: - `space_details` - `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. - `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with admin access. - `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with admin access. - `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with admin access. - Developer Preview: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space, supported field paths include: `permission_settings.manage_members_and_groups`, `permission_settings.modify_space_details`, `permission_settings.toggle_history`, `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually exclusive with all other non-permission settings field paths). `permission_settings` is not supported with admin access. + useAdminAccess: boolean, [Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Some `FieldMask` values are not supported using admin access. For details, see the description of `update_mask`. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -446,6 +490,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -461,6 +510,74 @@

Method Details

}
+
+ search(orderBy=None, pageSize=None, pageToken=None, query=None, useAdminAccess=None, x__xgafv=None) +
[Developer Preview](https://developers.google.com/workspace/preview). Returns a list of spaces based on a user's search. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). The user must be an administrator for the Google Workspace organization. In the request, set `use_admin_access` to `true`.
+
+Args:
+  orderBy: string, Optional. How the list of spaces is ordered. Supported attributes to order by are: - `membership_count.joined_direct_human_user_count` — Denotes the count of human users that have directly joined a space. - `last_active_time` — Denotes the time when last eligible item is added to any topic of this space. - `create_time` — Denotes the time of the space creation. Valid ordering operation values are: - `ASC` for ascending. Default value. - `DESC` for descending. The supported syntax are: - `membership_count.joined_direct_human_user_count DESC` - `membership_count.joined_direct_human_user_count ASC` - `last_active_time DESC` - `last_active_time ASC` - `create_time DESC` - `create_time ASC`
+  pageSize: integer, The maximum number of spaces to return. The service may return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000.
+  pageToken: string, A token, received from the previous search spaces call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
+  query: string, Required. A search query. You can search by using the following parameters: - `create_time` - `customer` - `display_name` - `external_user_allowed` - `last_active_time` - `space_history_state` - `space_type` `create_time` and `last_active_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `=`, `<`, `>`, `<=`, `>=`. `customer` is required and is used to indicate which customer to fetch spaces from. `customers/my_customer` is the only supported value. `display_name` only accepts the `HAS` (`:`) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's `display_name`. For example, `Fun Eve` matches `Fun event` or `The evening was fun`, but not `notFun event` or `even`. `external_user_allowed` accepts either `true` or `false`. `space_history_state` only accepts values from the [`historyState`] (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState) field of a `space` resource. `space_type` is required and the only valid value is `SPACE`. Across different fields, only `AND` operators are supported. A valid example is `space_type = "SPACE" AND display_name:"Hello"` and an invalid example is `space_type = "SPACE" OR display_name:"Hello"`. Among the same field, `space_type` doesn't support `AND` or `OR` operators. `display_name`, 'space_history_state', and 'external_user_allowed' only support `OR` operators. `last_active_time` and `create_time` support both `AND` and `OR` operators. `AND` can only be used to represent an interval, such as `last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00"`. The following example queries are valid: ``` customer = "customers/my_customer" AND space_type = "SPACE" customer = "customers/my_customer" AND space_type = "SPACE" AND display_name:"Hello World" customer = "customers/my_customer" AND space_type = "SPACE" AND (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time > "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (display_name:"Hello World" OR display_name:"Fun event") AND (last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time < "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (create_time > "2019-01-01T00:00:00+00:00" AND create_time < "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF") ```
+  useAdminAccess: boolean, When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.spaces.readonly` or `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). This method currently only supports admin access, thus only `true` is accepted for this field.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response with a list of spaces corresponding to the search spaces request.
+  "nextPageToken": "A String", # A token that can be used to retrieve the next page. If this field is empty, there are no subsequent pages.
+  "spaces": [ # A page of the requested spaces.
+    { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app.
+      "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`.
+        "accessState": "A String", # Output only. Indicates the access state of the space.
+        "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`.
+      },
+      "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
+      "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+      "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
+      "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
+      "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete.
+      "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview).
+      "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview).
+        "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group.
+        "joinedGroupCount": 42, # Count of all groups that have directly joined the space.
+      },
+      "name": "A String", # Resource name of the space. Format: `spaces/{space}`
+      "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human.
+      "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules.
+        "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters.
+        "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters.
+      },
+      "spaceHistoryState": "A String", # The message history state for messages and threads in this space.
+      "spaceThreadingState": "A String", # Output only. The threading state in the Chat space.
+      "spaceType": "A String", # The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.
+      "spaceUri": "A String", # Output only. The URI for a user to access the space.
+      "threaded": True or False, # Output only. Deprecated: Use `spaceThreadingState` instead. Whether messages are threaded in this space.
+      "type": "A String", # Output only. Deprecated: Use `space_type` instead. The type of a space.
+    },
+  ],
+  "totalSize": 42, # The total number of spaces that match the query, across all pages. If the result is over 10,000 spaces, this value is an estimate.
+}
+
+ +
+ search_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.
+        
+
+
setup(body=None, x__xgafv=None)
Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see [Set up a space with initial members](https://developers.google.com/workspace/chat/set-up-spaces). To specify the human members to add, add memberships with the appropriate `membership.member.name`. To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. To specify the Google groups to add, add memberships with the appropriate `membership.group_member.name`. To add or invite a Google group, use `groups/{group}`, where `{group}` is the `id` for the group from the Cloud Identity Groups API. For example, you can use [Cloud Identity Groups lookup API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup) to retrieve the ID `123456789` for group email `group@example.com`, then you can add the group to the space by setting the `membership.group_member.name` to `groups/123456789`. Group email is not supported, and Google groups can only be added as members in named spaces. For a named space or group chat, if the caller blocks, or is blocked by some members, or doesn't have permission to add some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to `true` and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see [Invite or add a user or app to a space](https://developers.google.com/workspace/chat/create-members). If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -500,6 +617,11 @@ 

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -533,6 +655,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. diff --git a/docs/dyn/chat_v1.spaces.members.html b/docs/dyn/chat_v1.spaces.members.html index fc399f1cee7..35e9b482d2f 100644 --- a/docs/dyn/chat_v1.spaces.members.html +++ b/docs/dyn/chat_v1.spaces.members.html @@ -78,22 +78,22 @@

Instance Methods

close()

Close httplib2 connections.

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

-

Creates a human membership or app membership for the calling app. Creating memberships for other apps isn't supported. For an example, see [Invite or add a user or a Google Chat app to a space](https://developers.google.com/workspace/chat/create-members). When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). To specify the member to add, set the `membership.member.name` for the human or app member, or set the `membership.group_member.name` for the group member. - To add the calling app to a space or a direct message between two human users, use `users/app`. Unable to add other apps to the space. - To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. - To add or invite a Google group in a named space, use `groups/{group}`, where `{group}` is the `id` for the group from the Cloud Identity Groups API. For example, you can use [Cloud Identity Groups lookup API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup) to retrieve the ID `123456789` for group email `group@example.com`, then you can add or invite the group to a named space by setting the `membership.group_member.name` to `groups/123456789`. Group email is not supported, and Google groups can only be added as members in named spaces.

+ create(parent, body=None, useAdminAccess=None, x__xgafv=None)

+

Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). For example usage, see: - [Invite or add a user to a space](https://developers.google.com/workspace/chat/create-members#create-user-membership). - [Invite or add a Google Group to a space](https://developers.google.com/workspace/chat/create-members#create-group-membership). - [Add the Chat app to a space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api).

- delete(name, x__xgafv=None)

+ delete(name, useAdminAccess=None, x__xgafv=None)

Deletes a membership. For an example, see [Remove a user or a Google Chat app from a space](https://developers.google.com/workspace/chat/delete-members). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

- get(name, x__xgafv=None)

+ get(name, useAdminAccess=None, x__xgafv=None)

Returns details about a membership. For an example, see [Get details about a user's or Google Chat app's membership](https://developers.google.com/workspace/chat/get-members). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

- list(parent, filter=None, pageSize=None, pageToken=None, showGroups=None, showInvited=None, x__xgafv=None)

+ list(parent, filter=None, pageSize=None, pageToken=None, showGroups=None, showInvited=None, useAdminAccess=None, x__xgafv=None)

Lists memberships in a space. For an example, see [List users and Google Chat apps in a space](https://developers.google.com/workspace/chat/list-members). Listing memberships with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) lists memberships in spaces that the authenticated user has access to. Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

list_next()

Retrieves the next page of results.

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

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

Updates a membership. For an example, see [Update a user's membership in a space](https://developers.google.com/workspace/chat/update-members). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

Method Details

@@ -102,8 +102,8 @@

Method Details

- create(parent, body=None, x__xgafv=None) -
Creates a human membership or app membership for the calling app. Creating memberships for other apps isn't supported. For an example, see [Invite or add a user or a Google Chat app to a space](https://developers.google.com/workspace/chat/create-members). When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). To specify the member to add, set the `membership.member.name` for the human or app member, or set the `membership.group_member.name` for the group member. - To add the calling app to a space or a direct message between two human users, use `users/app`. Unable to add other apps to the space. - To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. - To add or invite a Google group in a named space, use `groups/{group}`, where `{group}` is the `id` for the group from the Cloud Identity Groups API. For example, you can use [Cloud Identity Groups lookup API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup) to retrieve the ID `123456789` for group email `group@example.com`, then you can add or invite the group to a named space by setting the `membership.group_member.name` to `groups/123456789`. Group email is not supported, and Google groups can only be added as members in named spaces.
+    create(parent, body=None, useAdminAccess=None, x__xgafv=None)
+  
Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). For example usage, see: - [Invite or add a user to a space](https://developers.google.com/workspace/chat/create-members#create-user-membership). - [Invite or add a Google Group to a space](https://developers.google.com/workspace/chat/create-members#create-group-membership). - [Add the Chat app to a space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api).
 
 Args:
   parent: string, Required. The resource name of the space for which to create the membership. Format: spaces/{space} (required)
@@ -128,6 +128,7 @@ 

Method Details

"state": "A String", # Output only. State of the membership. } + useAdminAccess: boolean, [Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -156,11 +157,12 @@

Method Details

- delete(name, x__xgafv=None) + delete(name, useAdminAccess=None, x__xgafv=None)
Deletes a membership. For an example, see [Remove a user or a Google Chat app from a space](https://developers.google.com/workspace/chat/delete-members). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
 
 Args:
   name: string, Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a human membership, requires the `chat.memberships` scope and `spaces/{space}/members/{member}` format. You can use the email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. When deleting an app membership, requires the `chat.memberships.app` scope and `spaces/{space}/members/app` format. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`. (required)
+  useAdminAccess: boolean, [Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Deleting app memberships in a space isn't supported using admin access.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -189,11 +191,12 @@ 

Method Details

- get(name, x__xgafv=None) + get(name, useAdminAccess=None, x__xgafv=None)
Returns details about a membership. For an example, see [Get details about a user's or Google Chat app's membership](https://developers.google.com/workspace/chat/get-members). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
 
 Args:
   name: string, Required. Resource name of the membership to retrieve. To get the app's own membership [by using user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can optionally use `spaces/{space}/members/app`. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` When [authenticated as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can use the user's email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. (required)
+  useAdminAccess: boolean, [Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` or `chat.admin.memberships.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Getting app memberships in a space isn't supported when using admin access.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -222,7 +225,7 @@ 

Method Details

- list(parent, filter=None, pageSize=None, pageToken=None, showGroups=None, showInvited=None, x__xgafv=None) + list(parent, filter=None, pageSize=None, pageToken=None, showGroups=None, showInvited=None, useAdminAccess=None, x__xgafv=None)
Lists memberships in a space. For an example, see [List users and Google Chat apps in a space](https://developers.google.com/workspace/chat/list-members). Listing memberships with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) lists memberships in spaces that the authenticated user has access to. Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
 
 Args:
@@ -232,6 +235,7 @@ 

Method Details

pageToken: string, Optional. A page token, received from a previous call to list memberships. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results. showGroups: boolean, Optional. When `true`, also returns memberships associated with a Google Group, in addition to other types of memberships. If a filter is set, Google Group memberships that don't match the filter criteria aren't returned. showInvited: boolean, Optional. When `true`, also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited memberships that don't match the filter criteria aren't returned. Currently requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + useAdminAccess: boolean, [Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.memberships.readonly` or `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Listing app memberships in a space isn't supported when using admin access. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -279,7 +283,7 @@

Method Details

- patch(name, body=None, updateMask=None, x__xgafv=None) + patch(name, body=None, updateMask=None, useAdminAccess=None, x__xgafv=None)
Updates a membership. For an example, see [Update a user's membership in a space](https://developers.google.com/workspace/chat/update-members). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
 
 Args:
@@ -306,6 +310,7 @@ 

Method Details

} updateMask: string, Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `role` + useAdminAccess: boolean, [Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index 3cc2c5d8f86..e57763ab7ce 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -98,7 +98,7 @@

Instance Methods

Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Note: Might return a message from a blocked member or space.

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)

-

Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. For an example, see [List messages](/chat/api/guides/v1/messages/list). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

+

Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, `{}`. For an example, see [List messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

list_next()

Retrieves the next page of results.

@@ -333,7 +333,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -560,7 +560,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -819,7 +819,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -1046,7 +1046,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -1518,7 +1518,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -1745,7 +1745,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -1860,6 +1860,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -2107,7 +2112,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -2334,7 +2339,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -2593,7 +2598,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -2820,7 +2825,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -3292,7 +3297,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -3519,7 +3524,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -3634,6 +3639,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -3899,7 +3909,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -4126,7 +4136,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -4385,7 +4395,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -4612,7 +4622,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -5084,7 +5094,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -5311,7 +5321,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -5426,6 +5436,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -5450,7 +5465,7 @@

Method Details

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None) -
Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. For an example, see [List messages](/chat/api/guides/v1/messages/list). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
+  
Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, `{}`. For an example, see [List messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
 
 Args:
   parent: string, Required. The resource name of the space to list messages from. Format: `spaces/{space}` (required)
@@ -5679,7 +5694,7 @@ 

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -5906,7 +5921,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -6165,7 +6180,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -6392,7 +6407,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -6864,7 +6879,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -7091,7 +7106,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -7206,6 +7221,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -7464,7 +7484,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -7691,7 +7711,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -7950,7 +7970,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -8177,7 +8197,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -8649,7 +8669,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -8876,7 +8896,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -8991,6 +9011,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -9232,7 +9257,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -9459,7 +9484,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -9718,7 +9743,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -9945,7 +9970,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -10417,7 +10442,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -10644,7 +10669,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -10759,6 +10784,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -11000,7 +11030,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -11227,7 +11257,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -11486,7 +11516,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -11713,7 +11743,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -12185,7 +12215,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -12412,7 +12442,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -12527,6 +12557,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -12768,7 +12803,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -12995,7 +13030,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -13254,7 +13289,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -13481,7 +13516,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -13953,7 +13988,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -14180,7 +14215,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -14295,6 +14330,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html index 90060dda36e..8902453444b 100644 --- a/docs/dyn/chat_v1.spaces.spaceEvents.html +++ b/docs/dyn/chat_v1.spaces.spaceEvents.html @@ -448,7 +448,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -675,7 +675,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -934,7 +934,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -1161,7 +1161,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -1633,7 +1633,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -1860,7 +1860,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -1975,6 +1975,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -2211,7 +2216,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -2438,7 +2443,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -2697,7 +2702,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -2924,7 +2929,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -3396,7 +3401,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -3623,7 +3628,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -3738,6 +3743,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -3974,7 +3984,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -4201,7 +4211,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -4460,7 +4470,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -4687,7 +4697,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -5159,7 +5169,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -5386,7 +5396,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -5501,6 +5511,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -5735,7 +5750,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -5962,7 +5977,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -6221,7 +6236,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -6448,7 +6463,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -6920,7 +6935,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -7147,7 +7162,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -7262,6 +7277,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -7494,7 +7514,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -7721,7 +7741,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -7980,7 +8000,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -8207,7 +8227,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -8679,7 +8699,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -8906,7 +8926,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -9021,6 +9041,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -9253,7 +9278,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -9480,7 +9505,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -9739,7 +9764,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -9966,7 +9991,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -10438,7 +10463,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -10665,7 +10690,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -10780,6 +10805,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -10895,6 +10925,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -10922,6 +10957,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -11301,7 +11341,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -11528,7 +11568,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -11787,7 +11827,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -12014,7 +12054,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -12486,7 +12526,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -12713,7 +12753,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -12828,6 +12868,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -13064,7 +13109,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -13291,7 +13336,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -13550,7 +13595,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -13777,7 +13822,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -14249,7 +14294,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -14476,7 +14521,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -14591,6 +14636,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -14827,7 +14877,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -15054,7 +15104,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -15313,7 +15363,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -15540,7 +15590,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -16012,7 +16062,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -16239,7 +16289,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -16354,6 +16404,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -16588,7 +16643,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -16815,7 +16870,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -17074,7 +17129,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -17301,7 +17356,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -17773,7 +17828,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -18000,7 +18055,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -18115,6 +18170,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -18347,7 +18407,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -18574,7 +18634,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -18833,7 +18893,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -19060,7 +19120,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -19532,7 +19592,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -19759,7 +19819,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -19874,6 +19934,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -20106,7 +20171,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -20333,7 +20398,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -20592,7 +20657,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -20819,7 +20884,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -21291,7 +21356,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -21518,7 +21583,7 @@

Method Details

}, "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. - "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. + "hostAppDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat. "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of. "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. @@ -21633,6 +21698,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -21748,6 +21818,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. @@ -21775,6 +21850,11 @@

Method Details

"displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + "membershipCount": { # [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + "joinedDirectHumanUserCount": 42, # Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Count of all groups that have directly joined the space. + }, "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Details about the space including description and rules. diff --git a/docs/dyn/cloudasset_v1.operations.html b/docs/dyn/cloudasset_v1.operations.html index d3139edec8d..2526611839c 100644 --- a/docs/dyn/cloudasset_v1.operations.html +++ b/docs/dyn/cloudasset_v1.operations.html @@ -74,18 +74,66 @@

Cloud Asset API . operations

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`.

close()

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

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`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
close()
Close httplib2 connections.
+
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
get(name, x__xgafv=None)
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
diff --git a/docs/dyn/cloudasset_v1.v1.html b/docs/dyn/cloudasset_v1.v1.html
index f8fc24a261e..c5d675c2d45 100644
--- a/docs/dyn/cloudasset_v1.v1.html
+++ b/docs/dyn/cloudasset_v1.v1.html
@@ -2329,6 +2329,15 @@ 

Method Details

], }, ], + "enrichments": [ # Enrichments of the asset. + { # The enhanced metadata information for a resource. + "resourceOwners": { # The resource owners information. # The resource owners for a resource. Note that this field only contains the members that have "roles/owner" role in the resource's IAM Policy. + "resourceOwners": [ # List of resource owners. + "A String", + ], + }, + }, + ], "folders": [ # The folder(s) that this resource belongs to, in the form of folders/{FOLDER_NUMBER}. This field is available when the resource belongs to one or more folders. To search against `folders`: * Use a field query. Example: `folders:(123 OR 456)` * Use a free text query. Example: `123` * Specify the `scope` field as this folder in your search request. "A String", ], diff --git a/docs/dyn/cloudcontrolspartner_v1.organizations.locations.customers.html b/docs/dyn/cloudcontrolspartner_v1.organizations.locations.customers.html index f01096c6b82..ba4df357799 100644 --- a/docs/dyn/cloudcontrolspartner_v1.organizations.locations.customers.html +++ b/docs/dyn/cloudcontrolspartner_v1.organizations.locations.customers.html @@ -122,7 +122,7 @@

Method Details

}, ], }, - "displayName": "A String", # Optional. The customer organization's display name. E.g. "Google". + "displayName": "A String", # The customer organization's display name. E.g. "Google". "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` }
@@ -159,7 +159,7 @@

Method Details

}, ], }, - "displayName": "A String", # Optional. The customer organization's display name. E.g. "Google". + "displayName": "A String", # The customer organization's display name. E.g. "Google". "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` }, diff --git a/docs/dyn/cloudcontrolspartner_v1beta.organizations.locations.customers.html b/docs/dyn/cloudcontrolspartner_v1beta.organizations.locations.customers.html index 576a3ca6cdb..3639e34accc 100644 --- a/docs/dyn/cloudcontrolspartner_v1beta.organizations.locations.customers.html +++ b/docs/dyn/cloudcontrolspartner_v1beta.organizations.locations.customers.html @@ -122,7 +122,7 @@

Method Details

}, ], }, - "displayName": "A String", # Optional. The customer organization's display name. E.g. "Google". + "displayName": "A String", # The customer organization's display name. E.g. "Google". "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` }
@@ -159,7 +159,7 @@

Method Details

}, ], }, - "displayName": "A String", # Optional. The customer organization's display name. E.g. "Google". + "displayName": "A String", # The customer organization's display name. E.g. "Google". "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` }, diff --git a/docs/dyn/cloudidentity_v1.devices.html b/docs/dyn/cloudidentity_v1.devices.html index a9cc47f51d3..e096b231f33 100644 --- a/docs/dyn/cloudidentity_v1.devices.html +++ b/docs/dyn/cloudidentity_v1.devices.html @@ -436,7 +436,7 @@

Method Details

view: string, Optional. The view to use for the List request. Allowed values VIEW_UNSPECIFIED - Default value. The value is unused. - COMPANY_INVENTORY - This view contains all devices imported by the company admin. Each device in the response contains all information specified by the company admin when importing the device (i.e. asset tags). This includes devices that may be unaassigned or assigned to users. + COMPANY_INVENTORY - This view contains all devices imported by the company admin. Each device in the response contains all information specified by the company admin when importing the device (i.e. asset tags). This includes devices that may be unassigned or assigned to users. USER_ASSIGNED_DEVICES - This view contains all devices with at least one user registered on the device. Each device in the response contains all device information, except for asset tags. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/cloudkms_v1.folders.html b/docs/dyn/cloudkms_v1.folders.html index 01f04714530..22212a79040 100644 --- a/docs/dyn/cloudkms_v1.folders.html +++ b/docs/dyn/cloudkms_v1.folders.html @@ -106,6 +106,7 @@

Method Details

{ # Cloud KMS Autokey configuration for a folder. "keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration. "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`. + "state": "A String", # Output only. The state for the AutokeyConfig. }
@@ -121,6 +122,7 @@

Method Details

{ # Cloud KMS Autokey configuration for a folder. "keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration. "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`. + "state": "A String", # Output only. The state for the AutokeyConfig. } updateMask: string, Required. Masks which fields of the AutokeyConfig to update, e.g. `keyProject`. @@ -135,6 +137,7 @@

Method Details

{ # Cloud KMS Autokey configuration for a folder. "keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration. "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`. + "state": "A String", # Output only. The state for the AutokeyConfig. }
diff --git a/docs/dyn/cloudkms_v1.projects.locations.ekmConnections.html b/docs/dyn/cloudkms_v1.projects.locations.ekmConnections.html index 178e2737af5..c30d8d15b82 100644 --- a/docs/dyn/cloudkms_v1.projects.locations.ekmConnections.html +++ b/docs/dyn/cloudkms_v1.projects.locations.ekmConnections.html @@ -125,7 +125,7 @@

Method Details

"etag": "A String", # Optional. Etag of the currently stored EkmConnection. "keyManagementMode": "A String", # Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL. "name": "A String", # Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`. - "serviceResolvers": [ # A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported. + "serviceResolvers": [ # Optional. A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported. { # A ServiceResolver represents an EKM replica that can be reached within an EkmConnection. "endpointFilter": "A String", # Optional. The filter applied to the endpoints of the resolved service. If no filter is specified, all endpoints will be considered. An endpoint will be chosen arbitrarily from the filtered list for each request. For endpoint filter syntax and examples, see https://cloud.google.com/service-directory/docs/reference/rpc/google.cloud.servicedirectory.v1#resolveservicerequest. "hostname": "A String", # Required. The hostname of the EKM replica used at TLS and HTTP layers. @@ -164,7 +164,7 @@

Method Details

"etag": "A String", # Optional. Etag of the currently stored EkmConnection. "keyManagementMode": "A String", # Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL. "name": "A String", # Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`. - "serviceResolvers": [ # A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported. + "serviceResolvers": [ # Optional. A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported. { # A ServiceResolver represents an EKM replica that can be reached within an EkmConnection. "endpointFilter": "A String", # Optional. The filter applied to the endpoints of the resolved service. If no filter is specified, all endpoints will be considered. An endpoint will be chosen arbitrarily from the filtered list for each request. For endpoint filter syntax and examples, see https://cloud.google.com/service-directory/docs/reference/rpc/google.cloud.servicedirectory.v1#resolveservicerequest. "hostname": "A String", # Required. The hostname of the EKM replica used at TLS and HTTP layers. @@ -209,7 +209,7 @@

Method Details

"etag": "A String", # Optional. Etag of the currently stored EkmConnection. "keyManagementMode": "A String", # Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL. "name": "A String", # Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`. - "serviceResolvers": [ # A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported. + "serviceResolvers": [ # Optional. A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported. { # A ServiceResolver represents an EKM replica that can be reached within an EkmConnection. "endpointFilter": "A String", # Optional. The filter applied to the endpoints of the resolved service. If no filter is specified, all endpoints will be considered. An endpoint will be chosen arbitrarily from the filtered list for each request. For endpoint filter syntax and examples, see https://cloud.google.com/service-directory/docs/reference/rpc/google.cloud.servicedirectory.v1#resolveservicerequest. "hostname": "A String", # Required. The hostname of the EKM replica used at TLS and HTTP layers. @@ -308,7 +308,7 @@

Method Details

"etag": "A String", # Optional. Etag of the currently stored EkmConnection. "keyManagementMode": "A String", # Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL. "name": "A String", # Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`. - "serviceResolvers": [ # A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported. + "serviceResolvers": [ # Optional. A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported. { # A ServiceResolver represents an EKM replica that can be reached within an EkmConnection. "endpointFilter": "A String", # Optional. The filter applied to the endpoints of the resolved service. If no filter is specified, all endpoints will be considered. An endpoint will be chosen arbitrarily from the filtered list for each request. For endpoint filter syntax and examples, see https://cloud.google.com/service-directory/docs/reference/rpc/google.cloud.servicedirectory.v1#resolveservicerequest. "hostname": "A String", # Required. The hostname of the EKM replica used at TLS and HTTP layers. @@ -366,7 +366,7 @@

Method Details

"etag": "A String", # Optional. Etag of the currently stored EkmConnection. "keyManagementMode": "A String", # Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL. "name": "A String", # Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`. - "serviceResolvers": [ # A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported. + "serviceResolvers": [ # Optional. A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported. { # A ServiceResolver represents an EKM replica that can be reached within an EkmConnection. "endpointFilter": "A String", # Optional. The filter applied to the endpoints of the resolved service. If no filter is specified, all endpoints will be considered. An endpoint will be chosen arbitrarily from the filtered list for each request. For endpoint filter syntax and examples, see https://cloud.google.com/service-directory/docs/reference/rpc/google.cloud.servicedirectory.v1#resolveservicerequest. "hostname": "A String", # Required. The hostname of the EKM replica used at TLS and HTTP layers. @@ -405,7 +405,7 @@

Method Details

"etag": "A String", # Optional. Etag of the currently stored EkmConnection. "keyManagementMode": "A String", # Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL. "name": "A String", # Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`. - "serviceResolvers": [ # A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported. + "serviceResolvers": [ # Optional. A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported. { # A ServiceResolver represents an EKM replica that can be reached within an EkmConnection. "endpointFilter": "A String", # Optional. The filter applied to the endpoints of the resolved service. If no filter is specified, all endpoints will be considered. An endpoint will be chosen arbitrarily from the filtered list for each request. For endpoint filter syntax and examples, see https://cloud.google.com/service-directory/docs/reference/rpc/google.cloud.servicedirectory.v1#resolveservicerequest. "hostname": "A String", # Required. The hostname of the EKM replica used at TLS and HTTP layers. diff --git a/docs/dyn/cloudkms_v1.projects.locations.keyHandles.html b/docs/dyn/cloudkms_v1.projects.locations.keyHandles.html index cbfc5b24832..7c6b1424787 100644 --- a/docs/dyn/cloudkms_v1.projects.locations.keyHandles.html +++ b/docs/dyn/cloudkms_v1.projects.locations.keyHandles.html @@ -84,8 +84,11 @@

Instance Methods

get(name, x__xgafv=None)

Returns the KeyHandle.

- list(parent, filter=None, x__xgafv=None)

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

Lists KeyHandles.

+

+ list_next()

+

Retrieves the next page of results.

Method Details

close() @@ -159,12 +162,14 @@

Method Details

- list(parent, filter=None, x__xgafv=None) + list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists KeyHandles.
 
 Args:
   parent: string, Required. Name of the resource project and location from which to list KeyHandles, e.g. `projects/{PROJECT_ID}/locations/{LOCATION}`. (required)
   filter: string, Optional. Filter to apply when listing KeyHandles, e.g. `resource_type_selector="{SERVICE}.googleapis.com/{TYPE}"`.
+  pageSize: integer, Optional. Optional limit on the number of KeyHandles to include in the response. The service may return fewer than this value. Further KeyHandles can subsequently be obtained by including the ListKeyHandlesResponse.next_page_token in a subsequent request. If unspecified, at most KeyHandles 100 will be returned.
+  pageToken: string, Optional. Optional pagination token, returned earlier via ListKeyHandlesResponse.next_page_token.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -181,7 +186,22 @@ 

Method Details

"resourceTypeSelector": "A String", # Required. Indicates the resource type that the resulting CryptoKey is meant to protect, e.g. `{SERVICE}.googleapis.com/{TYPE}`. See documentation for supported resource types. }, ], + "nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in ListKeyHandlesRequest.page_token to retrieve the next page of results. }
+
+ list_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.
+        
+
+ \ No newline at end of file diff --git a/docs/dyn/cloudtrace_v1.projects.html b/docs/dyn/cloudtrace_v1.projects.html index c01a73afa4d..6b20b01d412 100644 --- a/docs/dyn/cloudtrace_v1.projects.html +++ b/docs/dyn/cloudtrace_v1.projects.html @@ -108,7 +108,7 @@

Method Details

{ # A span represents a single timed event within a trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace. "endTime": "A String", # End time of the span in seconds and nanoseconds from the UNIX epoch. "kind": "A String", # Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span. - "labels": { # Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 kilobytes (10MB for `/stacktrace` values). Some predefined label keys exist, or you may create your own. When creating your own, we recommend the following formats: * `/category/product/key` for agents of well-known products (e.g. `/db/mongodb/read_size`). * `short_host/path/key` for domain-specific keys (e.g. `foo.com/myproduct/bar`) Predefined labels include: * `/agent` * `/component` * `/error/message` * `/error/name` * `/http/client_city` * `/http/client_country` * `/http/client_protocol` * `/http/client_region` * `/http/host` * `/http/method` * `/http/path` * `/http/redirected_url` * `/http/request/size` * `/http/response/size` * `/http/route` * `/http/status_code` * `/http/url` * `/http/user_agent` * `/pid` * `/stacktrace` * `/tid` + "labels": { # Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 KiB. Some keys might have predefined meaning, and you can also create your own. For more information, see [Cloud Trace labels](https://cloud.google.com/trace/docs/trace-labels). "a_key": "A String", }, "name": "A String", # Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Trace tool in the Google Cloud Platform Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans. diff --git a/docs/dyn/cloudtrace_v1.projects.traces.html b/docs/dyn/cloudtrace_v1.projects.traces.html index 2b637e19813..456ddc3f957 100644 --- a/docs/dyn/cloudtrace_v1.projects.traces.html +++ b/docs/dyn/cloudtrace_v1.projects.traces.html @@ -113,7 +113,7 @@

Method Details

{ # A span represents a single timed event within a trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace. "endTime": "A String", # End time of the span in seconds and nanoseconds from the UNIX epoch. "kind": "A String", # Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span. - "labels": { # Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 kilobytes (10MB for `/stacktrace` values). Some predefined label keys exist, or you may create your own. When creating your own, we recommend the following formats: * `/category/product/key` for agents of well-known products (e.g. `/db/mongodb/read_size`). * `short_host/path/key` for domain-specific keys (e.g. `foo.com/myproduct/bar`) Predefined labels include: * `/agent` * `/component` * `/error/message` * `/error/name` * `/http/client_city` * `/http/client_country` * `/http/client_protocol` * `/http/client_region` * `/http/host` * `/http/method` * `/http/path` * `/http/redirected_url` * `/http/request/size` * `/http/response/size` * `/http/route` * `/http/status_code` * `/http/url` * `/http/user_agent` * `/pid` * `/stacktrace` * `/tid` + "labels": { # Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 KiB. Some keys might have predefined meaning, and you can also create your own. For more information, see [Cloud Trace labels](https://cloud.google.com/trace/docs/trace-labels). "a_key": "A String", }, "name": "A String", # Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Trace tool in the Google Cloud Platform Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans. @@ -161,7 +161,7 @@

Method Details

{ # A span represents a single timed event within a trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace. "endTime": "A String", # End time of the span in seconds and nanoseconds from the UNIX epoch. "kind": "A String", # Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span. - "labels": { # Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 kilobytes (10MB for `/stacktrace` values). Some predefined label keys exist, or you may create your own. When creating your own, we recommend the following formats: * `/category/product/key` for agents of well-known products (e.g. `/db/mongodb/read_size`). * `short_host/path/key` for domain-specific keys (e.g. `foo.com/myproduct/bar`) Predefined labels include: * `/agent` * `/component` * `/error/message` * `/error/name` * `/http/client_city` * `/http/client_country` * `/http/client_protocol` * `/http/client_region` * `/http/host` * `/http/method` * `/http/path` * `/http/redirected_url` * `/http/request/size` * `/http/response/size` * `/http/route` * `/http/status_code` * `/http/url` * `/http/user_agent` * `/pid` * `/stacktrace` * `/tid` + "labels": { # Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 KiB. Some keys might have predefined meaning, and you can also create your own. For more information, see [Cloud Trace labels](https://cloud.google.com/trace/docs/trace-labels). "a_key": "A String", }, "name": "A String", # Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Trace tool in the Google Cloud Platform Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans. diff --git a/docs/dyn/connectors_v1.projects.locations.endpointAttachments.html b/docs/dyn/connectors_v1.projects.locations.endpointAttachments.html index 40ce1012a7f..fd738f421b3 100644 --- a/docs/dyn/connectors_v1.projects.locations.endpointAttachments.html +++ b/docs/dyn/connectors_v1.projects.locations.endpointAttachments.html @@ -84,10 +84,10 @@

Instance Methods

delete(name, x__xgafv=None)

Deletes a single EndpointAttachment.

- get(name, x__xgafv=None)

+ get(name, view=None, x__xgafv=None)

Gets details of a single EndpointAttachment.

- list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)

List EndpointAttachments in a given project

list_next()

@@ -120,6 +120,7 @@

Method Details

}, "name": "A String", # Output only. Resource name of the Endpoint Attachment. Format: projects/{project}/locations/{location}/endpointAttachments/{endpoint_attachment} "serviceAttachment": "A String", # Required. The path of the service attachment + "state": "A String", # Output only. The Private Service Connect Connection Endpoint State. This value is only available in the Full view. "updateTime": "A String", # Output only. Updated time. } @@ -189,11 +190,16 @@

Method Details

- get(name, x__xgafv=None) + get(name, view=None, x__xgafv=None)
Gets details of a single EndpointAttachment.
 
 Args:
   name: string, Required. Resource name of the form: `projects/*/locations/*/endpointAttachments/*` (required)
+  view: string, Optional. Specifies which fields of the EndpointAttachment are returned in the response. Defaults to `ENDPOINT_ATTACHMENT_VIEW_BASIC` view.
+    Allowed values
+      ENDPOINT_ATTACHMENT_VIEW_UNSPECIFIED - ENDPOINT_ATTACHMENT_VIEW_UNSPECIFIED.
+      ENDPOINT_ATTACHMENT_VIEW_BASIC - Do not include status.
+      ENDPOINT_ATTACHMENT_VIEW_FULL - Includes Status.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -212,12 +218,13 @@ 

Method Details

}, "name": "A String", # Output only. Resource name of the Endpoint Attachment. Format: projects/{project}/locations/{location}/endpointAttachments/{endpoint_attachment} "serviceAttachment": "A String", # Required. The path of the service attachment + "state": "A String", # Output only. The Private Service Connect Connection Endpoint State. This value is only available in the Full view. "updateTime": "A String", # Output only. Updated time. }
- list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
List EndpointAttachments in a given project
 
 Args:
@@ -226,6 +233,11 @@ 

Method Details

orderBy: string, Order by parameters. pageSize: integer, Page size. pageToken: string, Page token. + view: string, Optional. Specifies which fields of the EndpointAttachment are returned in the response. Defaults to `ENDPOINT_ATTACHMENT_VIEW_BASIC` view. + Allowed values + ENDPOINT_ATTACHMENT_VIEW_UNSPECIFIED - ENDPOINT_ATTACHMENT_VIEW_UNSPECIFIED. + ENDPOINT_ATTACHMENT_VIEW_BASIC - Do not include status. + ENDPOINT_ATTACHMENT_VIEW_FULL - Includes Status. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -246,6 +258,7 @@

Method Details

}, "name": "A String", # Output only. Resource name of the Endpoint Attachment. Format: projects/{project}/locations/{location}/endpointAttachments/{endpoint_attachment} "serviceAttachment": "A String", # Required. The path of the service attachment + "state": "A String", # Output only. The Private Service Connect Connection Endpoint State. This value is only available in the Full view. "updateTime": "A String", # Output only. Updated time. }, ], @@ -289,6 +302,7 @@

Method Details

}, "name": "A String", # Output only. Resource name of the Endpoint Attachment. Format: projects/{project}/locations/{location}/endpointAttachments/{endpoint_attachment} "serviceAttachment": "A String", # Required. The path of the service attachment + "state": "A String", # Output only. The Private Service Connect Connection Endpoint State. This value is only available in the Full view. "updateTime": "A String", # Output only. Updated time. } diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html index b2d7824346c..ac8843583e3 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.html +++ b/docs/dyn/container_v1.projects.locations.clusters.html @@ -525,7 +525,7 @@

Method Details

}, }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, @@ -1105,6 +1105,10 @@

Method Details

"privateEndpointSubnetwork": "A String", # Subnet to provision the master's private endpoint during cluster creation. Specified in projects/*/regions/*/subnetworks/* format. "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. }, + "rbacBindingConfig": { # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. + "enableInsecureBindingSystemAuthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated. + "enableInsecureBindingSystemUnauthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated. + }, "releaseChannel": { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version. "channel": "A String", # channel specifies which release channel the cluster is subscribed to. }, @@ -1556,7 +1560,7 @@

Method Details

}, }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, @@ -2136,6 +2140,10 @@

Method Details

"privateEndpointSubnetwork": "A String", # Subnet to provision the master's private endpoint during cluster creation. Specified in projects/*/regions/*/subnetworks/* format. "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. }, + "rbacBindingConfig": { # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. + "enableInsecureBindingSystemAuthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated. + "enableInsecureBindingSystemUnauthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated. + }, "releaseChannel": { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version. "channel": "A String", # channel specifies which release channel the cluster is subscribed to. }, @@ -2490,7 +2498,7 @@

Method Details

}, }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, @@ -3070,6 +3078,10 @@

Method Details

"privateEndpointSubnetwork": "A String", # Subnet to provision the master's private endpoint during cluster creation. Specified in projects/*/regions/*/subnetworks/* format. "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. }, + "rbacBindingConfig": { # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. + "enableInsecureBindingSystemAuthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated. + "enableInsecureBindingSystemUnauthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated. + }, "releaseChannel": { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version. "channel": "A String", # channel specifies which release channel the cluster is subscribed to. }, @@ -3599,7 +3611,7 @@

Method Details

"name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`. "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update. - "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, @@ -4313,6 +4325,10 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. }, "desiredPrivateIpv6GoogleAccess": "A String", # The desired state of IPv6 connectivity to Google Services. + "desiredRbacBindingConfig": { # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. + "enableInsecureBindingSystemAuthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated. + "enableInsecureBindingSystemUnauthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated. + }, "desiredReleaseChannel": { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # The desired release channel configuration. "channel": "A String", # channel specifies which release channel the cluster is subscribed to. }, diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index 718a8a48aa2..ada3393bd91 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -613,7 +613,7 @@

Method Details

}, }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, @@ -1193,6 +1193,10 @@

Method Details

"privateEndpointSubnetwork": "A String", # Subnet to provision the master's private endpoint during cluster creation. Specified in projects/*/regions/*/subnetworks/* format. "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. }, + "rbacBindingConfig": { # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. + "enableInsecureBindingSystemAuthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated. + "enableInsecureBindingSystemUnauthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated. + }, "releaseChannel": { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version. "channel": "A String", # channel specifies which release channel the cluster is subscribed to. }, @@ -1644,7 +1648,7 @@

Method Details

}, }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, @@ -2224,6 +2228,10 @@

Method Details

"privateEndpointSubnetwork": "A String", # Subnet to provision the master's private endpoint during cluster creation. Specified in projects/*/regions/*/subnetworks/* format. "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. }, + "rbacBindingConfig": { # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. + "enableInsecureBindingSystemAuthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated. + "enableInsecureBindingSystemUnauthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated. + }, "releaseChannel": { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version. "channel": "A String", # channel specifies which release channel the cluster is subscribed to. }, @@ -2622,7 +2630,7 @@

Method Details

}, }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, @@ -3202,6 +3210,10 @@

Method Details

"privateEndpointSubnetwork": "A String", # Subnet to provision the master's private endpoint during cluster creation. Specified in projects/*/regions/*/subnetworks/* format. "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. }, + "rbacBindingConfig": { # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. + "enableInsecureBindingSystemAuthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated. + "enableInsecureBindingSystemUnauthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated. + }, "releaseChannel": { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version. "channel": "A String", # channel specifies which release channel the cluster is subscribed to. }, @@ -3779,7 +3791,7 @@

Method Details

"name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`. "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update. - "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, @@ -4340,6 +4352,10 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. }, "desiredPrivateIpv6GoogleAccess": "A String", # The desired state of IPv6 connectivity to Google Services. + "desiredRbacBindingConfig": { # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. + "enableInsecureBindingSystemAuthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated. + "enableInsecureBindingSystemUnauthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated. + }, "desiredReleaseChannel": { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # The desired release channel configuration. "channel": "A String", # channel specifies which release channel the cluster is subscribed to. }, diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index 40b6ef667ad..75d02eae48a 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -556,7 +556,7 @@

Method Details

"master": { # Master is the configuration for components on master. # Configuration for master components. }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, @@ -1186,6 +1186,10 @@

Method Details

}, "workloadVulnerabilityMode": "A String", # Sets which mode to use for Protect workload vulnerability scanning feature. }, + "rbacBindingConfig": { # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. + "enableInsecureBindingSystemAuthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated. + "enableInsecureBindingSystemUnauthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated. + }, "releaseChannel": { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version. "channel": "A String", # channel specifies which release channel the cluster is subscribed to. }, @@ -1681,7 +1685,7 @@

Method Details

"master": { # Master is the configuration for components on master. # Configuration for master components. }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, @@ -2311,6 +2315,10 @@

Method Details

}, "workloadVulnerabilityMode": "A String", # Sets which mode to use for Protect workload vulnerability scanning feature. }, + "rbacBindingConfig": { # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. + "enableInsecureBindingSystemAuthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated. + "enableInsecureBindingSystemUnauthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated. + }, "releaseChannel": { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version. "channel": "A String", # channel specifies which release channel the cluster is subscribed to. }, @@ -2709,7 +2717,7 @@

Method Details

"master": { # Master is the configuration for components on master. # Configuration for master components. }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, @@ -3339,6 +3347,10 @@

Method Details

}, "workloadVulnerabilityMode": "A String", # Sets which mode to use for Protect workload vulnerability scanning feature. }, + "rbacBindingConfig": { # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. + "enableInsecureBindingSystemAuthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated. + "enableInsecureBindingSystemUnauthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated. + }, "releaseChannel": { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version. "channel": "A String", # channel specifies which release channel the cluster is subscribed to. }, @@ -3888,7 +3900,7 @@

Method Details

"name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`. "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update. - "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, @@ -4638,6 +4650,10 @@

Method Details

}, "workloadVulnerabilityMode": "A String", # Sets which mode to use for Protect workload vulnerability scanning feature. }, + "desiredRbacBindingConfig": { # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. + "enableInsecureBindingSystemAuthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated. + "enableInsecureBindingSystemUnauthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated. + }, "desiredReleaseChannel": { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # The desired release channel configuration. "channel": "A String", # channel specifies which release channel the cluster is subscribed to. }, diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index f2d0b95fd3c..f65989b0a43 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -651,7 +651,7 @@

Method Details

"master": { # Master is the configuration for components on master. # Configuration for master components. }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, @@ -1281,6 +1281,10 @@

Method Details

}, "workloadVulnerabilityMode": "A String", # Sets which mode to use for Protect workload vulnerability scanning feature. }, + "rbacBindingConfig": { # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. + "enableInsecureBindingSystemAuthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated. + "enableInsecureBindingSystemUnauthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated. + }, "releaseChannel": { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version. "channel": "A String", # channel specifies which release channel the cluster is subscribed to. }, @@ -1776,7 +1780,7 @@

Method Details

"master": { # Master is the configuration for components on master. # Configuration for master components. }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, @@ -2406,6 +2410,10 @@

Method Details

}, "workloadVulnerabilityMode": "A String", # Sets which mode to use for Protect workload vulnerability scanning feature. }, + "rbacBindingConfig": { # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. + "enableInsecureBindingSystemAuthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated. + "enableInsecureBindingSystemUnauthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated. + }, "releaseChannel": { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version. "channel": "A String", # channel specifies which release channel the cluster is subscribed to. }, @@ -2848,7 +2856,7 @@

Method Details

"master": { # Master is the configuration for components on master. # Configuration for master components. }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, @@ -3478,6 +3486,10 @@

Method Details

}, "workloadVulnerabilityMode": "A String", # Sets which mode to use for Protect workload vulnerability scanning feature. }, + "rbacBindingConfig": { # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. + "enableInsecureBindingSystemAuthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated. + "enableInsecureBindingSystemUnauthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated. + }, "releaseChannel": { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version. "channel": "A String", # channel specifies which release channel the cluster is subscribed to. }, @@ -4068,7 +4080,7 @@

Method Details

"name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`. "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update. - "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, @@ -4665,6 +4677,10 @@

Method Details

}, "workloadVulnerabilityMode": "A String", # Sets which mode to use for Protect workload vulnerability scanning feature. }, + "desiredRbacBindingConfig": { # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. + "enableInsecureBindingSystemAuthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated. + "enableInsecureBindingSystemUnauthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated. + }, "desiredReleaseChannel": { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # The desired release channel configuration. "channel": "A String", # channel specifies which release channel the cluster is subscribed to. }, diff --git a/docs/dyn/containeranalysis_v1.projects.locations.notes.html b/docs/dyn/containeranalysis_v1.projects.locations.notes.html index e757a72980d..573855b13dc 100644 --- a/docs/dyn/containeranalysis_v1.projects.locations.notes.html +++ b/docs/dyn/containeranalysis_v1.projects.locations.notes.html @@ -94,6 +94,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets the specified note.

+

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

+

Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

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

Lists notes for the specified project.

@@ -103,6 +106,12 @@

Instance Methods

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

Updates the specified note.

+

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

+

Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

+

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

+

Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

Method Details

batchCreate(parent, body=None, x__xgafv=None) @@ -1627,6 +1636,49 @@

Method Details

}
+
+ getIamPolicy(resource, body=None, x__xgafv=None) +
Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `GetIamPolicy` method.
+  "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
+    "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user: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/).
+  "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).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists notes for the specified project.
@@ -2547,4 +2599,92 @@ 

Method Details

}
+
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user: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.
+    "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).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user: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/).
+  "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).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html b/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html index 7ab6582ff37..acc5db622cc 100644 --- a/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html +++ b/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html @@ -89,6 +89,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets the specified occurrence.

+

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

+

Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

getNotes(name, x__xgafv=None)

Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.

@@ -104,6 +107,12 @@

Instance Methods

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

Updates the specified occurrence.

+

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

+

Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

+

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

+

Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

Method Details

batchCreate(parent, body=None, x__xgafv=None) @@ -4257,6 +4266,49 @@

Method Details

}
+
+ getIamPolicy(resource, body=None, x__xgafv=None) +
Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `GetIamPolicy` method.
+  "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
+    "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user: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/).
+  "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).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+
getNotes(name, x__xgafv=None)
Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.
@@ -7085,4 +7137,92 @@ 

Method Details

}
+
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user: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.
+    "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).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user: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/).
+  "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).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/customsearch_v1.cse.html b/docs/dyn/customsearch_v1.cse.html index 998d50de11f..657e548a1d4 100644 --- a/docs/dyn/customsearch_v1.cse.html +++ b/docs/dyn/customsearch_v1.cse.html @@ -83,7 +83,7 @@

Instance Methods

close()

Close httplib2 connections.

- list(c2coff=None, cr=None, cx=None, dateRestrict=None, exactTerms=None, excludeTerms=None, fileType=None, filter=None, gl=None, googlehost=None, highRange=None, hl=None, hq=None, imgColorType=None, imgDominantColor=None, imgSize=None, imgType=None, linkSite=None, lowRange=None, lr=None, num=None, orTerms=None, q=None, relatedSite=None, rights=None, safe=None, searchType=None, siteSearch=None, siteSearchFilter=None, snippetLength=None, sort=None, start=None, x__xgafv=None)

+ list(c2coff=None, cr=None, cx=None, dateRestrict=None, enableAlternateSearchHandler=None, exactTerms=None, excludeTerms=None, fileType=None, filter=None, gl=None, googlehost=None, highRange=None, hl=None, hq=None, imgColorType=None, imgDominantColor=None, imgSize=None, imgType=None, linkSite=None, lowRange=None, lr=None, num=None, orTerms=None, q=None, relatedSite=None, rights=None, safe=None, searchType=None, siteSearch=None, siteSearchFilter=None, snippetLength=None, sort=None, start=None, x__xgafv=None)

Returns metadata about the search performed, metadata about the engine used for the search, and the search results.

Method Details

@@ -92,7 +92,7 @@

Method Details

- list(c2coff=None, cr=None, cx=None, dateRestrict=None, exactTerms=None, excludeTerms=None, fileType=None, filter=None, gl=None, googlehost=None, highRange=None, hl=None, hq=None, imgColorType=None, imgDominantColor=None, imgSize=None, imgType=None, linkSite=None, lowRange=None, lr=None, num=None, orTerms=None, q=None, relatedSite=None, rights=None, safe=None, searchType=None, siteSearch=None, siteSearchFilter=None, snippetLength=None, sort=None, start=None, x__xgafv=None) + list(c2coff=None, cr=None, cx=None, dateRestrict=None, enableAlternateSearchHandler=None, exactTerms=None, excludeTerms=None, fileType=None, filter=None, gl=None, googlehost=None, highRange=None, hl=None, hq=None, imgColorType=None, imgDominantColor=None, imgSize=None, imgType=None, linkSite=None, lowRange=None, lr=None, num=None, orTerms=None, q=None, relatedSite=None, rights=None, safe=None, searchType=None, siteSearch=None, siteSearchFilter=None, snippetLength=None, sort=None, start=None, x__xgafv=None)
Returns metadata about the search performed, metadata about the engine used for the search, and the search results.
 
 Args:
@@ -100,6 +100,7 @@ 

Method Details

cr: string, Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) page for a list of valid values for this parameter. cx: string, The Programmable Search Engine ID to use for this request. dateRestrict: string, Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years. + enableAlternateSearchHandler: boolean, Optional. Enables routing of Programmable Search Engine requests to an alternate search handler. exactTerms: string, Identifies a phrase that all documents in the search results must contain. excludeTerms: string, Identifies a word or phrase that should not appear in any documents in the search results. fileType: string, Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help Center](https://support.google.com/webmasters/answer/35287). diff --git a/docs/dyn/customsearch_v1.cse.siterestrict.html b/docs/dyn/customsearch_v1.cse.siterestrict.html index c5de58337d9..8d4c5770110 100644 --- a/docs/dyn/customsearch_v1.cse.siterestrict.html +++ b/docs/dyn/customsearch_v1.cse.siterestrict.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- list(c2coff=None, cr=None, cx=None, dateRestrict=None, exactTerms=None, excludeTerms=None, fileType=None, filter=None, gl=None, googlehost=None, highRange=None, hl=None, hq=None, imgColorType=None, imgDominantColor=None, imgSize=None, imgType=None, linkSite=None, lowRange=None, lr=None, num=None, orTerms=None, q=None, relatedSite=None, rights=None, safe=None, searchType=None, siteSearch=None, siteSearchFilter=None, snippetLength=None, sort=None, start=None, x__xgafv=None)

+ list(c2coff=None, cr=None, cx=None, dateRestrict=None, enableAlternateSearchHandler=None, exactTerms=None, excludeTerms=None, fileType=None, filter=None, gl=None, googlehost=None, highRange=None, hl=None, hq=None, imgColorType=None, imgDominantColor=None, imgSize=None, imgType=None, linkSite=None, lowRange=None, lr=None, num=None, orTerms=None, q=None, relatedSite=None, rights=None, safe=None, searchType=None, siteSearch=None, siteSearchFilter=None, snippetLength=None, sort=None, start=None, x__xgafv=None)

Returns metadata about the search performed, metadata about the engine used for the search, and the search results. Uses a small set of url patterns.

Method Details

@@ -87,7 +87,7 @@

Method Details

- list(c2coff=None, cr=None, cx=None, dateRestrict=None, exactTerms=None, excludeTerms=None, fileType=None, filter=None, gl=None, googlehost=None, highRange=None, hl=None, hq=None, imgColorType=None, imgDominantColor=None, imgSize=None, imgType=None, linkSite=None, lowRange=None, lr=None, num=None, orTerms=None, q=None, relatedSite=None, rights=None, safe=None, searchType=None, siteSearch=None, siteSearchFilter=None, snippetLength=None, sort=None, start=None, x__xgafv=None) + list(c2coff=None, cr=None, cx=None, dateRestrict=None, enableAlternateSearchHandler=None, exactTerms=None, excludeTerms=None, fileType=None, filter=None, gl=None, googlehost=None, highRange=None, hl=None, hq=None, imgColorType=None, imgDominantColor=None, imgSize=None, imgType=None, linkSite=None, lowRange=None, lr=None, num=None, orTerms=None, q=None, relatedSite=None, rights=None, safe=None, searchType=None, siteSearch=None, siteSearchFilter=None, snippetLength=None, sort=None, start=None, x__xgafv=None)
Returns metadata about the search performed, metadata about the engine used for the search, and the search results. Uses a small set of url patterns.
 
 Args:
@@ -95,6 +95,7 @@ 

Method Details

cr: string, Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) page for a list of valid values for this parameter. cx: string, The Programmable Search Engine ID to use for this request. dateRestrict: string, Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years. + enableAlternateSearchHandler: boolean, Optional. Enables routing of Programmable Search Engine requests to an alternate search handler. exactTerms: string, Identifies a phrase that all documents in the search results must contain. excludeTerms: string, Identifies a word or phrase that should not appear in any documents in the search results. fileType: string, Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help Center](https://support.google.com/webmasters/answer/35287). diff --git a/docs/dyn/dataflow_v1b3.projects.jobs.workItems.html b/docs/dyn/dataflow_v1b3.projects.jobs.workItems.html index 4fd31ac9e76..43ed5114593 100644 --- a/docs/dyn/dataflow_v1b3.projects.jobs.workItems.html +++ b/docs/dyn/dataflow_v1b3.projects.jobs.workItems.html @@ -599,6 +599,8 @@

Method Details

"userStepToStateFamilyNameMap": { # Map from user step names to state families. "a_key": "A String", }, + "userWorkerRunnerV1Settings": "A String", # Binary encoded proto to control runtime behavior of the java runner v1 user worker. + "userWorkerRunnerV2Settings": "A String", # Binary encoded proto to control runtime behavior of the runner v2 user worker. "windmillServiceEndpoint": "A String", # If present, the worker must use this endpoint to communicate with Windmill Service dispatchers, otherwise the worker must continue to use whatever endpoint it had been using. "windmillServicePort": "A String", # If present, the worker must use this port to communicate with Windmill Service dispatchers. Only applicable when windmill_service_endpoint is specified. }, diff --git a/docs/dyn/dataflow_v1b3.projects.locations.jobs.workItems.html b/docs/dyn/dataflow_v1b3.projects.locations.jobs.workItems.html index 949b8d7ae45..4ccb6f7745b 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.jobs.workItems.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.jobs.workItems.html @@ -600,6 +600,8 @@

Method Details

"userStepToStateFamilyNameMap": { # Map from user step names to state families. "a_key": "A String", }, + "userWorkerRunnerV1Settings": "A String", # Binary encoded proto to control runtime behavior of the java runner v1 user worker. + "userWorkerRunnerV2Settings": "A String", # Binary encoded proto to control runtime behavior of the runner v2 user worker. "windmillServiceEndpoint": "A String", # If present, the worker must use this endpoint to communicate with Windmill Service dispatchers, otherwise the worker must continue to use whatever endpoint it had been using. "windmillServicePort": "A String", # If present, the worker must use this port to communicate with Windmill Service dispatchers. Only applicable when windmill_service_endpoint is specified. }, diff --git a/docs/dyn/dataplex_v1.organizations.locations.html b/docs/dyn/dataplex_v1.organizations.locations.html index 2dd62931cca..f444b44b2cf 100644 --- a/docs/dyn/dataplex_v1.organizations.locations.html +++ b/docs/dyn/dataplex_v1.organizations.locations.html @@ -79,6 +79,11 @@

Instance Methods

Returns the encryptionConfigs Resource.

+

+ operations() +

+

Returns the operations Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/dataplex_v1.organizations.locations.operations.html b/docs/dyn/dataplex_v1.organizations.locations.operations.html new file mode 100644 index 00000000000..a1cf41763d2 --- /dev/null +++ b/docs/dyn/dataplex_v1.organizations.locations.operations.html @@ -0,0 +1,235 @@ + + + +

Cloud Dataplex API . organizations . locations . operations

+

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.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

+

+ get(name, x__xgafv=None)

+

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

+

+ listOperations(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

+

+ listOperations_next()

+

Retrieves the next page of results.

+

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.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
+  "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ listOperations(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
+      "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+}
+
+ +
+ listOperations_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.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataplex_v1.projects.locations.entryLinkTypes.html b/docs/dyn/dataplex_v1.projects.locations.entryLinkTypes.html new file mode 100644 index 00000000000..c62c53fb494 --- /dev/null +++ b/docs/dyn/dataplex_v1.projects.locations.entryLinkTypes.html @@ -0,0 +1,258 @@ + + + +

Cloud Dataplex API . projects . locations . entryLinkTypes

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ getIamPolicy(resource, options_requestedPolicyVersion=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.

+

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

+

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

+

+ 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.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ getIamPolicy(resource, options_requestedPolicyVersion=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.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user: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).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+  "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SetIamPolicy method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user: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).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+    "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+  "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:paths: "bindings, etag"
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user: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).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+  "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ 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.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for TestIamPermissions method.
+  "permissions": [ # The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for TestIamPermissions method.
+  "permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataplex_v1.projects.locations.glossaries.categories.html b/docs/dyn/dataplex_v1.projects.locations.glossaries.categories.html new file mode 100644 index 00000000000..ce0efc8d0b4 --- /dev/null +++ b/docs/dyn/dataplex_v1.projects.locations.glossaries.categories.html @@ -0,0 +1,258 @@ + + + +

Cloud Dataplex API . projects . locations . glossaries . categories

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ getIamPolicy(resource, options_requestedPolicyVersion=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.

+

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

+

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

+

+ 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.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ getIamPolicy(resource, options_requestedPolicyVersion=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.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user: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).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+  "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SetIamPolicy method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user: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).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+    "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+  "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:paths: "bindings, etag"
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user: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).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+  "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ 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.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for TestIamPermissions method.
+  "permissions": [ # The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for TestIamPermissions method.
+  "permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataplex_v1.projects.locations.glossaries.html b/docs/dyn/dataplex_v1.projects.locations.glossaries.html index ee78e79fada..9b1583dc8b3 100644 --- a/docs/dyn/dataplex_v1.projects.locations.glossaries.html +++ b/docs/dyn/dataplex_v1.projects.locations.glossaries.html @@ -74,6 +74,16 @@

Cloud Dataplex API . projects . locations . glossaries

Instance Methods

+

+ categories() +

+

Returns the categories Resource.

+ +

+ terms() +

+

Returns the terms Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/dataplex_v1.projects.locations.glossaries.terms.html b/docs/dyn/dataplex_v1.projects.locations.glossaries.terms.html new file mode 100644 index 00000000000..f0b57d565ae --- /dev/null +++ b/docs/dyn/dataplex_v1.projects.locations.glossaries.terms.html @@ -0,0 +1,258 @@ + + + +

Cloud Dataplex API . projects . locations . glossaries . terms

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ getIamPolicy(resource, options_requestedPolicyVersion=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.

+

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

+

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

+

+ 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.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ getIamPolicy(resource, options_requestedPolicyVersion=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.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user: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).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+  "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SetIamPolicy method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user: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).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+    "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+  "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:paths: "bindings, etag"
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user: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).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+  "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ 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.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for TestIamPermissions method.
+  "permissions": [ # The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for TestIamPermissions method.
+  "permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataplex_v1.projects.locations.html b/docs/dyn/dataplex_v1.projects.locations.html index e73770032a8..fba9b633226 100644 --- a/docs/dyn/dataplex_v1.projects.locations.html +++ b/docs/dyn/dataplex_v1.projects.locations.html @@ -99,6 +99,11 @@

Instance Methods

Returns the entryGroups Resource.

+

+ entryLinkTypes() +

+

Returns the entryLinkTypes Resource.

+

entryTypes()

diff --git a/docs/dyn/datastream_v1.projects.locations.streams.html b/docs/dyn/datastream_v1.projects.locations.streams.html index 599524fc3b2..9ec3c45e077 100644 --- a/docs/dyn/datastream_v1.projects.locations.streams.html +++ b/docs/dyn/datastream_v1.projects.locations.streams.html @@ -102,7 +102,7 @@

Instance Methods

Use this method to update the configuration of a stream.

run(name, body=None, x__xgafv=None)

-

Use this method to start, resume or recover a stream with a non default CDC strategy. NOTE: This feature is currently experimental.

+

Use this method to start, resume or recover a stream with a non default CDC strategy.

Method Details

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

Method Details

run(name, body=None, x__xgafv=None) -
Use this method to start, resume or recover a stream with a non default CDC strategy. NOTE: This feature is currently experimental.
+  
Use this method to start, resume or recover a stream with a non default CDC strategy.
 
 Args:
   name: string, Required. Name of the stream resource to start, in the format: projects/{project_id}/locations/{location}/streams/{stream_name} (required)
diff --git a/docs/dyn/dfareporting_v3_5.media.html b/docs/dyn/dfareporting_v3_5.media.html
index 7ba7e194e6d..d4e5d561ea5 100644
--- a/docs/dyn/dfareporting_v3_5.media.html
+++ b/docs/dyn/dfareporting_v3_5.media.html
@@ -199,28 +199,6 @@ 

Method Details

"value": "A String", # The value of the dimension. }, "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata". - "mediaRequestInfo": { # Extra information added to operations that support Scotty media requests. - "currentBytes": "A String", # The number of current bytes uploaded or downloaded. - "customData": "A String", # Data to be copied to backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications. - "diffObjectVersion": "A String", # Set if the http request info is diff encoded. The value of this field is the version number of the base revision. This is corresponding to Apiary's mediaDiffObjectVersion (//depot/google3/java/com/google/api/server/media/variable/DiffObjectVersionVariable.java). See go/esf-scotty-diff-upload for more information. - "finalStatus": 42, # The existence of the final_status field indicates that this is the last call to the agent for this request_id. http://google3/uploader/agent/scotty_agent.proto?l=737&rcl=347601929 - "notificationType": "A String", # The type of notification received from Scotty. - "requestId": "A String", # The Scotty request ID. - "requestReceivedParamsServingInfo": "A String", # The partition of the Scotty server handling this request. type is uploader_service.RequestReceivedParamsServingInfo LINT.IfChange(request_received_params_serving_info_annotations) LINT.ThenChange() - "totalBytes": "A String", # The total size of the file. - "totalBytesIsEstimated": True or False, # Whether the total bytes field contains an estimated data. - }, - "mediaResponseInfo": { # This message is for backends to pass their scotty media specific fields to ESF. Backend will include this in their response message to ESF. Example: ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile(ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse will include apiserving.MediaResponseInfo to tell ESF about data like dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse { optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo media_response_info = 2 } - "customData": "A String", # Data to copy from backend response to the next backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications. - "dataStorageTransform": "A String", # Specifies any transformation to be applied to data before persisting it or retrieving from storage. E.g., encryption options for blobstore2. This should be of the form uploader_service.DataStorageTransform. - "dynamicDropTarget": "A String", # Specifies the Scotty Drop Target to use for uploads. If present in a media response, Scotty does not upload to a standard drop zone. Instead, Scotty saves the upload directly to the location specified in this drop target. Unlike drop zones, the drop target is the final storage location for an upload. So, the agent does not need to clone the blob at the end of the upload. The agent is responsible for garbage collecting any orphaned blobs that may occur due to aborted uploads. For more information, see the drop target design doc here: http://goto/ScottyDropTarget This field will be preferred to dynamicDropzone. If provided, the identified field in the response must be of the type uploader.agent.DropTarget. - "dynamicDropzone": "A String", # Specifies the Scotty dropzone to use for uploads. - "requestClass": "A String", # Request class to use for all Blobstore operations for this request. - "scottyAgentUserId": "A String", # Requester ID passed along to be recorded in the Scotty logs - "scottyCustomerLog": "A String", # Customer-specific data to be recorded in the Scotty logs type is logs_proto_scotty.CustomerLog - "trafficClassField": "A String", # Specifies the TrafficClass that Scotty should use for any RPCs to fetch the response bytes. Will override the traffic class GTOS of the incoming http request. This is a temporary field to facilitate whitelisting and experimentation by the bigstore agent only. For instance, this does not apply to RTMP reads. WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM. - "verifyHashFromHeader": True or False, # Tells Scotty to verify hashes on the agent's behalf by parsing out the X-Goog-Hash header. - }, "richMedia": True or False, # True if the uploaded asset is a rich media asset. This is a read-only, auto-generated field. "timerCustomEvents": [ # List of timer events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset. { # Creative Custom Event. @@ -377,28 +355,6 @@

Method Details

"value": "A String", # The value of the dimension. }, "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata". - "mediaRequestInfo": { # Extra information added to operations that support Scotty media requests. - "currentBytes": "A String", # The number of current bytes uploaded or downloaded. - "customData": "A String", # Data to be copied to backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications. - "diffObjectVersion": "A String", # Set if the http request info is diff encoded. The value of this field is the version number of the base revision. This is corresponding to Apiary's mediaDiffObjectVersion (//depot/google3/java/com/google/api/server/media/variable/DiffObjectVersionVariable.java). See go/esf-scotty-diff-upload for more information. - "finalStatus": 42, # The existence of the final_status field indicates that this is the last call to the agent for this request_id. http://google3/uploader/agent/scotty_agent.proto?l=737&rcl=347601929 - "notificationType": "A String", # The type of notification received from Scotty. - "requestId": "A String", # The Scotty request ID. - "requestReceivedParamsServingInfo": "A String", # The partition of the Scotty server handling this request. type is uploader_service.RequestReceivedParamsServingInfo LINT.IfChange(request_received_params_serving_info_annotations) LINT.ThenChange() - "totalBytes": "A String", # The total size of the file. - "totalBytesIsEstimated": True or False, # Whether the total bytes field contains an estimated data. - }, - "mediaResponseInfo": { # This message is for backends to pass their scotty media specific fields to ESF. Backend will include this in their response message to ESF. Example: ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile(ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse will include apiserving.MediaResponseInfo to tell ESF about data like dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse { optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo media_response_info = 2 } - "customData": "A String", # Data to copy from backend response to the next backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications. - "dataStorageTransform": "A String", # Specifies any transformation to be applied to data before persisting it or retrieving from storage. E.g., encryption options for blobstore2. This should be of the form uploader_service.DataStorageTransform. - "dynamicDropTarget": "A String", # Specifies the Scotty Drop Target to use for uploads. If present in a media response, Scotty does not upload to a standard drop zone. Instead, Scotty saves the upload directly to the location specified in this drop target. Unlike drop zones, the drop target is the final storage location for an upload. So, the agent does not need to clone the blob at the end of the upload. The agent is responsible for garbage collecting any orphaned blobs that may occur due to aborted uploads. For more information, see the drop target design doc here: http://goto/ScottyDropTarget This field will be preferred to dynamicDropzone. If provided, the identified field in the response must be of the type uploader.agent.DropTarget. - "dynamicDropzone": "A String", # Specifies the Scotty dropzone to use for uploads. - "requestClass": "A String", # Request class to use for all Blobstore operations for this request. - "scottyAgentUserId": "A String", # Requester ID passed along to be recorded in the Scotty logs - "scottyCustomerLog": "A String", # Customer-specific data to be recorded in the Scotty logs type is logs_proto_scotty.CustomerLog - "trafficClassField": "A String", # Specifies the TrafficClass that Scotty should use for any RPCs to fetch the response bytes. Will override the traffic class GTOS of the incoming http request. This is a temporary field to facilitate whitelisting and experimentation by the bigstore agent only. For instance, this does not apply to RTMP reads. WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM. - "verifyHashFromHeader": True or False, # Tells Scotty to verify hashes on the agent's behalf by parsing out the X-Goog-Hash header. - }, "richMedia": True or False, # True if the uploaded asset is a rich media asset. This is a read-only, auto-generated field. "timerCustomEvents": [ # List of timer events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset. { # Creative Custom Event. diff --git a/docs/dyn/dfareporting_v4.conversions.html b/docs/dyn/dfareporting_v4.conversions.html index b4744188bff..0f4cfa3532e 100644 --- a/docs/dyn/dfareporting_v4.conversions.html +++ b/docs/dyn/dfareporting_v4.conversions.html @@ -97,6 +97,18 @@

Method Details

"conversions": [ # The set of conversions to insert. { # A Conversion represents when a user successfully performs a desired action after seeing an ad. "adUserDataConsent": "A String", # This represents consent for ad user data. + "cartData": { # Contains additional information about cart data. # The cart data associated with this conversion. + "items": [ # Data of the items purchased. + { # Contains data of the items purchased. + "itemId": "A String", # The shopping id of the item. Must be equal to the Merchant Center product identifier. This is a required field. + "quantity": 42, # Number of items sold. This is a required field. + "unitPrice": 3.14, # Unit price excluding tax, shipping, and any transaction level discounts. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field. + }, + ], + "merchantFeedLabel": "A String", # The feed labels associated with the feed where your items are uploaded. For more information, please refer to ​​ https://support.google.com/merchants/answer/12453549. This is a required field. + "merchantFeedLanguage": "A String", # The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. This field is needed only when item IDs are not unique across multiple Merchant Center feeds. + "merchantId": "A String", # The Merchant Center ID where the items are uploaded. + }, "childDirectedTreatment": True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance. "customVariables": [ # Custom floodlight variables. This field may only be used when calling batchinsert; it is not supported by batchupdate. { # A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate. @@ -165,6 +177,18 @@

Method Details

{ # The original conversion that was inserted or updated and whether there were any errors. "conversion": { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted or updated. "adUserDataConsent": "A String", # This represents consent for ad user data. + "cartData": { # Contains additional information about cart data. # The cart data associated with this conversion. + "items": [ # Data of the items purchased. + { # Contains data of the items purchased. + "itemId": "A String", # The shopping id of the item. Must be equal to the Merchant Center product identifier. This is a required field. + "quantity": 42, # Number of items sold. This is a required field. + "unitPrice": 3.14, # Unit price excluding tax, shipping, and any transaction level discounts. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field. + }, + ], + "merchantFeedLabel": "A String", # The feed labels associated with the feed where your items are uploaded. For more information, please refer to ​​ https://support.google.com/merchants/answer/12453549. This is a required field. + "merchantFeedLanguage": "A String", # The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. This field is needed only when item IDs are not unique across multiple Merchant Center feeds. + "merchantId": "A String", # The Merchant Center ID where the items are uploaded. + }, "childDirectedTreatment": True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance. "customVariables": [ # Custom floodlight variables. This field may only be used when calling batchinsert; it is not supported by batchupdate. { # A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate. @@ -234,6 +258,18 @@

Method Details

"conversions": [ # The set of conversions to update. { # A Conversion represents when a user successfully performs a desired action after seeing an ad. "adUserDataConsent": "A String", # This represents consent for ad user data. + "cartData": { # Contains additional information about cart data. # The cart data associated with this conversion. + "items": [ # Data of the items purchased. + { # Contains data of the items purchased. + "itemId": "A String", # The shopping id of the item. Must be equal to the Merchant Center product identifier. This is a required field. + "quantity": 42, # Number of items sold. This is a required field. + "unitPrice": 3.14, # Unit price excluding tax, shipping, and any transaction level discounts. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field. + }, + ], + "merchantFeedLabel": "A String", # The feed labels associated with the feed where your items are uploaded. For more information, please refer to ​​ https://support.google.com/merchants/answer/12453549. This is a required field. + "merchantFeedLanguage": "A String", # The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. This field is needed only when item IDs are not unique across multiple Merchant Center feeds. + "merchantId": "A String", # The Merchant Center ID where the items are uploaded. + }, "childDirectedTreatment": True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance. "customVariables": [ # Custom floodlight variables. This field may only be used when calling batchinsert; it is not supported by batchupdate. { # A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate. @@ -302,6 +338,18 @@

Method Details

{ # The original conversion that was inserted or updated and whether there were any errors. "conversion": { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted or updated. "adUserDataConsent": "A String", # This represents consent for ad user data. + "cartData": { # Contains additional information about cart data. # The cart data associated with this conversion. + "items": [ # Data of the items purchased. + { # Contains data of the items purchased. + "itemId": "A String", # The shopping id of the item. Must be equal to the Merchant Center product identifier. This is a required field. + "quantity": 42, # Number of items sold. This is a required field. + "unitPrice": 3.14, # Unit price excluding tax, shipping, and any transaction level discounts. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field. + }, + ], + "merchantFeedLabel": "A String", # The feed labels associated with the feed where your items are uploaded. For more information, please refer to ​​ https://support.google.com/merchants/answer/12453549. This is a required field. + "merchantFeedLanguage": "A String", # The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. This field is needed only when item IDs are not unique across multiple Merchant Center feeds. + "merchantId": "A String", # The Merchant Center ID where the items are uploaded. + }, "childDirectedTreatment": True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance. "customVariables": [ # Custom floodlight variables. This field may only be used when calling batchinsert; it is not supported by batchupdate. { # A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate. diff --git a/docs/dyn/dfareporting_v4.directorySites.html b/docs/dyn/dfareporting_v4.directorySites.html index bbf69ed7797..0e908e14fe9 100644 --- a/docs/dyn/dfareporting_v4.directorySites.html +++ b/docs/dyn/dfareporting_v4.directorySites.html @@ -128,6 +128,7 @@

Method Details

], "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". "name": "A String", # Name of this directory site. + "publisherSpecificationId": "A String", # Output only. Default publisher specification ID of video placements under this directory site. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max "settings": { # Directory Site Settings # Directory site settings. "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives. "dfpSettings": { # Google Ad Manager Settings # Directory site Ad Manager settings. @@ -171,6 +172,7 @@

Method Details

], "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". "name": "A String", # Name of this directory site. + "publisherSpecificationId": "A String", # Output only. Default publisher specification ID of video placements under this directory site. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max "settings": { # Directory Site Settings # Directory site settings. "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives. "dfpSettings": { # Google Ad Manager Settings # Directory site Ad Manager settings. @@ -212,6 +214,7 @@

Method Details

], "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". "name": "A String", # Name of this directory site. + "publisherSpecificationId": "A String", # Output only. Default publisher specification ID of video placements under this directory site. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max "settings": { # Directory Site Settings # Directory site settings. "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives. "dfpSettings": { # Google Ad Manager Settings # Directory site Ad Manager settings. @@ -279,6 +282,7 @@

Method Details

], "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". "name": "A String", # Name of this directory site. + "publisherSpecificationId": "A String", # Output only. Default publisher specification ID of video placements under this directory site. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max "settings": { # Directory Site Settings # Directory site settings. "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives. "dfpSettings": { # Google Ad Manager Settings # Directory site Ad Manager settings. diff --git a/docs/dyn/dfareporting_v4.placements.html b/docs/dyn/dfareporting_v4.placements.html index a8c9558502f..3a77ac79ccf 100644 --- a/docs/dyn/dfareporting_v4.placements.html +++ b/docs/dyn/dfareporting_v4.placements.html @@ -180,6 +180,7 @@

Method Details

"accountId": "A String", # Account ID of this placement. This field can be left blank. "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived. "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect. + "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. { # Represents the dimensions of ads, placements, creatives, or creative assets. "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. @@ -299,6 +300,7 @@

Method Details

"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. "value": "A String", # The value of the dimension. }, + "siteServed": True or False, # Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM. "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion. "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. @@ -354,7 +356,7 @@

Method Details

"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. }, "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. - "publisherSpecificationId": "A String", # Publisher specification ID of a video placement. + "publisherSpecificationId": "A String", # Publisher specification ID of a video placement. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. @@ -392,6 +394,7 @@

Method Details

"accountId": "A String", # Account ID of this placement. This field can be left blank. "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived. "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect. + "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. { # Represents the dimensions of ads, placements, creatives, or creative assets. "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. @@ -511,6 +514,7 @@

Method Details

"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. "value": "A String", # The value of the dimension. }, + "siteServed": True or False, # Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM. "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion. "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. @@ -566,7 +570,7 @@

Method Details

"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. }, "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. - "publisherSpecificationId": "A String", # Publisher specification ID of a video placement. + "publisherSpecificationId": "A String", # Publisher specification ID of a video placement. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. @@ -602,6 +606,7 @@

Method Details

"accountId": "A String", # Account ID of this placement. This field can be left blank. "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived. "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect. + "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. { # Represents the dimensions of ads, placements, creatives, or creative assets. "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. @@ -721,6 +726,7 @@

Method Details

"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. "value": "A String", # The value of the dimension. }, + "siteServed": True or False, # Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM. "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion. "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. @@ -776,7 +782,7 @@

Method Details

"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. }, "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. - "publisherSpecificationId": "A String", # Publisher specification ID of a video placement. + "publisherSpecificationId": "A String", # Publisher specification ID of a video placement. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. @@ -874,6 +880,7 @@

Method Details

"accountId": "A String", # Account ID of this placement. This field can be left blank. "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived. "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect. + "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. { # Represents the dimensions of ads, placements, creatives, or creative assets. "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. @@ -993,6 +1000,7 @@

Method Details

"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. "value": "A String", # The value of the dimension. }, + "siteServed": True or False, # Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM. "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion. "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. @@ -1048,7 +1056,7 @@

Method Details

"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. }, "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. - "publisherSpecificationId": "A String", # Publisher specification ID of a video placement. + "publisherSpecificationId": "A String", # Publisher specification ID of a video placement. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. @@ -1103,6 +1111,7 @@

Method Details

"accountId": "A String", # Account ID of this placement. This field can be left blank. "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived. "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect. + "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. { # Represents the dimensions of ads, placements, creatives, or creative assets. "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. @@ -1222,6 +1231,7 @@

Method Details

"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. "value": "A String", # The value of the dimension. }, + "siteServed": True or False, # Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM. "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion. "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. @@ -1277,7 +1287,7 @@

Method Details

"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. }, "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. - "publisherSpecificationId": "A String", # Publisher specification ID of a video placement. + "publisherSpecificationId": "A String", # Publisher specification ID of a video placement. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. @@ -1313,6 +1323,7 @@

Method Details

"accountId": "A String", # Account ID of this placement. This field can be left blank. "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived. "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect. + "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. { # Represents the dimensions of ads, placements, creatives, or creative assets. "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. @@ -1432,6 +1443,7 @@

Method Details

"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. "value": "A String", # The value of the dimension. }, + "siteServed": True or False, # Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM. "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion. "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. @@ -1487,7 +1499,7 @@

Method Details

"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. }, "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. - "publisherSpecificationId": "A String", # Publisher specification ID of a video placement. + "publisherSpecificationId": "A String", # Publisher specification ID of a video placement. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. @@ -1525,6 +1537,7 @@

Method Details

"accountId": "A String", # Account ID of this placement. This field can be left blank. "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived. "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect. + "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. { # Represents the dimensions of ads, placements, creatives, or creative assets. "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. @@ -1644,6 +1657,7 @@

Method Details

"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. "value": "A String", # The value of the dimension. }, + "siteServed": True or False, # Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM. "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion. "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. @@ -1699,7 +1713,7 @@

Method Details

"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. }, "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. - "publisherSpecificationId": "A String", # Publisher specification ID of a video placement. + "publisherSpecificationId": "A String", # Publisher specification ID of a video placement. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. @@ -1735,6 +1749,7 @@

Method Details

"accountId": "A String", # Account ID of this placement. This field can be left blank. "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived. "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect. + "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. { # Represents the dimensions of ads, placements, creatives, or creative assets. "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. @@ -1854,6 +1869,7 @@

Method Details

"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. "value": "A String", # The value of the dimension. }, + "siteServed": True or False, # Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM. "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion. "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. @@ -1909,7 +1925,7 @@

Method Details

"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. }, "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. - "publisherSpecificationId": "A String", # Publisher specification ID of a video placement. + "publisherSpecificationId": "A String", # Publisher specification ID of a video placement. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. diff --git a/docs/dyn/dfareporting_v4.sites.html b/docs/dyn/dfareporting_v4.sites.html index 16b166c4d5c..f7cf4e05bce 100644 --- a/docs/dyn/dfareporting_v4.sites.html +++ b/docs/dyn/dfareporting_v4.sites.html @@ -118,6 +118,7 @@

Method Details

{ # Contains properties of a site. "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. + "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv "approved": True or False, # Whether this site is approved. "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. @@ -200,7 +201,7 @@

Method Details

"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. }, "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. - "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. + "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. @@ -234,6 +235,7 @@

Method Details

{ # Contains properties of a site. "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. + "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv "approved": True or False, # Whether this site is approved. "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. @@ -316,7 +318,7 @@

Method Details

"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. }, "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. - "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. + "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. @@ -348,6 +350,7 @@

Method Details

{ # Contains properties of a site. "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. + "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv "approved": True or False, # Whether this site is approved. "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. @@ -430,7 +433,7 @@

Method Details

"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. }, "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. - "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. + "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. @@ -494,6 +497,7 @@

Method Details

"sites": [ # Site collection. { # Contains properties of a site. "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. + "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv "approved": True or False, # Whether this site is approved. "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. @@ -576,7 +580,7 @@

Method Details

"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. }, "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. - "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. + "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. @@ -627,6 +631,7 @@

Method Details

{ # Contains properties of a site. "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. + "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv "approved": True or False, # Whether this site is approved. "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. @@ -709,7 +714,7 @@

Method Details

"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. }, "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. - "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. + "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. @@ -741,6 +746,7 @@

Method Details

{ # Contains properties of a site. "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. + "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv "approved": True or False, # Whether this site is approved. "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. @@ -823,7 +829,7 @@

Method Details

"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. }, "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. - "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. + "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. @@ -857,6 +863,7 @@

Method Details

{ # Contains properties of a site. "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. + "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv "approved": True or False, # Whether this site is approved. "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. @@ -939,7 +946,7 @@

Method Details

"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. }, "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. - "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. + "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. @@ -971,6 +978,7 @@

Method Details

{ # Contains properties of a site. "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. + "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv "approved": True or False, # Whether this site is approved. "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. @@ -1053,7 +1061,7 @@

Method Details

"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. }, "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. - "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. + "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.html b/docs/dyn/dialogflow_v3.projects.locations.agents.html index 8f4d60d00ed..3289b2748fa 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.html @@ -208,6 +208,11 @@

Method Details

"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent. }, "avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration. + "clientCertificateSettings": { # Settings for custom client certificates. # Optional. Settings for custom client certificates. + "passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "sslCertificate": "A String", # Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. + }, "defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method. "description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected. "displayName": "A String", # Required. The human-readable name of the agent, unique within the location. @@ -300,6 +305,11 @@

Method Details

"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent. }, "avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration. + "clientCertificateSettings": { # Settings for custom client certificates. # Optional. Settings for custom client certificates. + "passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "sslCertificate": "A String", # Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. + }, "defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method. "description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected. "displayName": "A String", # Required. The human-readable name of the agent, unique within the location. @@ -466,6 +476,11 @@

Method Details

"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent. }, "avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration. + "clientCertificateSettings": { # Settings for custom client certificates. # Optional. Settings for custom client certificates. + "passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "sslCertificate": "A String", # Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. + }, "defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method. "description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected. "displayName": "A String", # Required. The human-readable name of the agent, unique within the location. @@ -658,6 +673,11 @@

Method Details

"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent. }, "avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration. + "clientCertificateSettings": { # Settings for custom client certificates. # Optional. Settings for custom client certificates. + "passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "sslCertificate": "A String", # Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. + }, "defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method. "description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected. "displayName": "A String", # Required. The human-readable name of the agent, unique within the location. @@ -769,6 +789,11 @@

Method Details

"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent. }, "avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration. + "clientCertificateSettings": { # Settings for custom client certificates. # Optional. Settings for custom client certificates. + "passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "sslCertificate": "A String", # Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. + }, "defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method. "description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected. "displayName": "A String", # Required. The human-readable name of the agent, unique within the location. @@ -862,6 +887,11 @@

Method Details

"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent. }, "avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration. + "clientCertificateSettings": { # Settings for custom client certificates. # Optional. Settings for custom client certificates. + "passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "sslCertificate": "A String", # Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. + }, "defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method. "description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected. "displayName": "A String", # Required. The human-readable name of the agent, unique within the location. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html index 4b42e32920e..ed7ec3ee195 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html @@ -223,6 +223,11 @@

Method Details

"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent. }, "avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration. + "clientCertificateSettings": { # Settings for custom client certificates. # Optional. Settings for custom client certificates. + "passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "sslCertificate": "A String", # Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. + }, "defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method. "description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected. "displayName": "A String", # Required. The human-readable name of the agent, unique within the location. @@ -316,6 +321,11 @@

Method Details

"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent. }, "avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration. + "clientCertificateSettings": { # Settings for custom client certificates. # Optional. Settings for custom client certificates. + "passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "sslCertificate": "A String", # Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. + }, "defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method. "description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected. "displayName": "A String", # Required. The human-readable name of the agent, unique within the location. @@ -483,6 +493,11 @@

Method Details

"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent. }, "avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration. + "clientCertificateSettings": { # Settings for custom client certificates. # Optional. Settings for custom client certificates. + "passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "sslCertificate": "A String", # Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. + }, "defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method. "description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected. "displayName": "A String", # Required. The human-readable name of the agent, unique within the location. @@ -680,6 +695,11 @@

Method Details

"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent. }, "avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration. + "clientCertificateSettings": { # Settings for custom client certificates. # Optional. Settings for custom client certificates. + "passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "sslCertificate": "A String", # Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. + }, "defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method. "description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected. "displayName": "A String", # Required. The human-readable name of the agent, unique within the location. @@ -792,6 +812,11 @@

Method Details

"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent. }, "avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration. + "clientCertificateSettings": { # Settings for custom client certificates. # Optional. Settings for custom client certificates. + "passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "sslCertificate": "A String", # Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. + }, "defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method. "description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected. "displayName": "A String", # Required. The human-readable name of the agent, unique within the location. @@ -886,6 +911,11 @@

Method Details

"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent. }, "avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration. + "clientCertificateSettings": { # Settings for custom client certificates. # Optional. Settings for custom client certificates. + "passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}` + "sslCertificate": "A String", # Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. + }, "defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method. "description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected. "displayName": "A String", # Required. The human-readable name of the agent, unique within the location. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.html index 3a9587973f0..e49c56b6ac6 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.html @@ -85,18 +85,19 @@

Instance Methods

Returns the operations Resource.

- batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None)

+ batchGetDocumentsMetadata(parent, matcher_fhirMatcher_fhirResources=None, matcher_urisMatcher_uris=None, x__xgafv=None)

Gets index freshness metadata for Documents. Supported for website search only.

close()

Close httplib2 connections.

Method Details

- batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None) + batchGetDocumentsMetadata(parent, matcher_fhirMatcher_fhirResources=None, matcher_urisMatcher_uris=None, x__xgafv=None)
Gets index freshness metadata for Documents. Supported for website search only.
 
 Args:
   parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. (required)
+  matcher_fhirMatcher_fhirResources: string, Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} (repeated)
   matcher_urisMatcher_uris: string, The exact URIs to match by. (repeated)
   x__xgafv: string, V1 error format.
     Allowed values
@@ -109,8 +110,10 @@ 

Method Details

{ # Response message for DocumentService.BatchGetDocumentsMetadata method. "documentsMetadata": [ # The metadata of the Documents. { # The metadata of a Document. + "dataIngestionSource": "A String", # The data ingestion source of the Document. Allowed values are: * `batch`: Data ingested via Batch API, e.g., ImportDocuments. * `streaming` Data ingested via Streaming API, e.g., FHIR streaming. "lastRefreshedTime": "A String", # The timestamp of the last time the Document was last indexed. "matcherValue": { # The value of the matcher that was used to match the Document. # The value of the matcher that was used to match the Document. + "fhirResource": "A String", # Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} "uri": "A String", # If match by URI, the URI of the Document. }, "status": "A String", # The status of the document. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html index 6069bf445bc..4ad05625a5e 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html @@ -619,7 +619,7 @@

Method Details

An object of the form: { # Response message for SearchService.Search method. - "attributionToken": "A String", # A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. + "attributionToken": "A String", # A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios. "correctedQuery": "A String", # Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search. "facets": [ # Results of facets requested by user. { # A facet result. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html index 83622ca0d29..8facf1ace7f 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html @@ -619,7 +619,7 @@

Method Details

An object of the form: { # Response message for SearchService.Search method. - "attributionToken": "A String", # A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. + "attributionToken": "A String", # A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios. "correctedQuery": "A String", # Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search. "facets": [ # Results of facets requested by user. { # A facet result. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.html index 02b2c6adce8..25b72e146db 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.html @@ -85,18 +85,19 @@

Instance Methods

Returns the operations Resource.

- batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None)

+ batchGetDocumentsMetadata(parent, matcher_fhirMatcher_fhirResources=None, matcher_urisMatcher_uris=None, x__xgafv=None)

Gets index freshness metadata for Documents. Supported for website search only.

close()

Close httplib2 connections.

Method Details

- batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None) + batchGetDocumentsMetadata(parent, matcher_fhirMatcher_fhirResources=None, matcher_urisMatcher_uris=None, x__xgafv=None)
Gets index freshness metadata for Documents. Supported for website search only.
 
 Args:
   parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. (required)
+  matcher_fhirMatcher_fhirResources: string, Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} (repeated)
   matcher_urisMatcher_uris: string, The exact URIs to match by. (repeated)
   x__xgafv: string, V1 error format.
     Allowed values
@@ -109,8 +110,10 @@ 

Method Details

{ # Response message for DocumentService.BatchGetDocumentsMetadata method. "documentsMetadata": [ # The metadata of the Documents. { # The metadata of a Document. + "dataIngestionSource": "A String", # The data ingestion source of the Document. Allowed values are: * `batch`: Data ingested via Batch API, e.g., ImportDocuments. * `streaming` Data ingested via Streaming API, e.g., FHIR streaming. "lastRefreshedTime": "A String", # The timestamp of the last time the Document was last indexed. "matcherValue": { # The value of the matcher that was used to match the Document. # The value of the matcher that was used to match the Document. + "fhirResource": "A String", # Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} "uri": "A String", # If match by URI, the URI of the Document. }, "status": "A String", # The status of the document. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html index 6bd135d8a78..e01e2425891 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html @@ -619,7 +619,7 @@

Method Details

An object of the form: { # Response message for SearchService.Search method. - "attributionToken": "A String", # A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. + "attributionToken": "A String", # A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios. "correctedQuery": "A String", # Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search. "facets": [ # Results of facets requested by user. { # A facet result. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.html index 6fa20df4abb..543222500db 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.html @@ -85,18 +85,19 @@

Instance Methods

Returns the operations Resource.

- batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None)

+ batchGetDocumentsMetadata(parent, matcher_fhirMatcher_fhirResources=None, matcher_urisMatcher_uris=None, x__xgafv=None)

Gets index freshness metadata for Documents. Supported for website search only.

close()

Close httplib2 connections.

Method Details

- batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None) + batchGetDocumentsMetadata(parent, matcher_fhirMatcher_fhirResources=None, matcher_urisMatcher_uris=None, x__xgafv=None)
Gets index freshness metadata for Documents. Supported for website search only.
 
 Args:
   parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. (required)
+  matcher_fhirMatcher_fhirResources: string, Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} (repeated)
   matcher_urisMatcher_uris: string, The exact URIs to match by. (repeated)
   x__xgafv: string, V1 error format.
     Allowed values
@@ -109,8 +110,10 @@ 

Method Details

{ # Response message for DocumentService.BatchGetDocumentsMetadata method. "documentsMetadata": [ # The metadata of the Documents. { # The metadata of a Document. + "dataIngestionSource": "A String", # The data ingestion source of the Document. Allowed values are: * `batch`: Data ingested via Batch API, e.g., ImportDocuments. * `streaming` Data ingested via Streaming API, e.g., FHIR streaming. "lastRefreshedTime": "A String", # The timestamp of the last time the Document was last indexed. "matcherValue": { # The value of the matcher that was used to match the Document. # The value of the matcher that was used to match the Document. + "fhirResource": "A String", # Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} "uri": "A String", # If match by URI, the URI of the Document. }, "status": "A String", # The status of the document. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html index aac1610fb9f..0063e331df5 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html @@ -1117,7 +1117,7 @@

Method Details

"appliedControls": [ # Controls applied as part of the Control service. "A String", ], - "attributionToken": "A String", # A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. + "attributionToken": "A String", # A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios. "correctedQuery": "A String", # Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search. "facets": [ # Results of facets requested by user. { # A facet result. @@ -1174,6 +1174,7 @@

Method Details

"numberConstraint": { # Constraint expression of a number field. Example: price < 100. # Numerical constraint expression. "comparison": "A String", # The comparison operation performed between the field value and the value specified in the constraint. "fieldName": "A String", # Name of the numerical field as defined in the schema. + "querySegment": "A String", # Identifies the keywords within the search query that match a filter. "value": 3.14, # The value specified in the numerical constraint. }, "orExpr": { # Logical `Or` operator. # Logical "Or" compound operator connecting multiple expressions. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html index f16b40a938f..89ce7a4fe79 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html @@ -1117,7 +1117,7 @@

Method Details

"appliedControls": [ # Controls applied as part of the Control service. "A String", ], - "attributionToken": "A String", # A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. + "attributionToken": "A String", # A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios. "correctedQuery": "A String", # Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search. "facets": [ # Results of facets requested by user. { # A facet result. @@ -1174,6 +1174,7 @@

Method Details

"numberConstraint": { # Constraint expression of a number field. Example: price < 100. # Numerical constraint expression. "comparison": "A String", # The comparison operation performed between the field value and the value specified in the constraint. "fieldName": "A String", # Name of the numerical field as defined in the schema. + "querySegment": "A String", # Identifies the keywords within the search query that match a filter. "value": 3.14, # The value specified in the numerical constraint. }, "orExpr": { # Logical `Or` operator. # Logical "Or" compound operator connecting multiple expressions. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.html index ac371f62254..5d371b81240 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.html @@ -85,18 +85,19 @@

Instance Methods

Returns the operations Resource.

- batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None)

+ batchGetDocumentsMetadata(parent, matcher_fhirMatcher_fhirResources=None, matcher_urisMatcher_uris=None, x__xgafv=None)

Gets index freshness metadata for Documents. Supported for website search only.

close()

Close httplib2 connections.

Method Details

- batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None) + batchGetDocumentsMetadata(parent, matcher_fhirMatcher_fhirResources=None, matcher_urisMatcher_uris=None, x__xgafv=None)
Gets index freshness metadata for Documents. Supported for website search only.
 
 Args:
   parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. (required)
+  matcher_fhirMatcher_fhirResources: string, Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} (repeated)
   matcher_urisMatcher_uris: string, The exact URIs to match by. (repeated)
   x__xgafv: string, V1 error format.
     Allowed values
@@ -109,8 +110,10 @@ 

Method Details

{ # Response message for DocumentService.BatchGetDocumentsMetadata method. "documentsMetadata": [ # The metadata of the Documents. { # The metadata of a Document. + "dataIngestionSource": "A String", # The data ingestion source of the Document. Allowed values are: * `batch`: Data ingested via Batch API, e.g., ImportDocuments. * `streaming` Data ingested via Streaming API, e.g., FHIR streaming. "lastRefreshedTime": "A String", # The timestamp of the last time the Document was last indexed. "matcherValue": { # The value of the matcher that was used to match the Document. # The value of the matcher that was used to match the Document. + "fhirResource": "A String", # Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} "uri": "A String", # If match by URI, the URI of the Document. }, "status": "A String", # The status of the document. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html index 765210a61ce..c17b7963034 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html @@ -1117,7 +1117,7 @@

Method Details

"appliedControls": [ # Controls applied as part of the Control service. "A String", ], - "attributionToken": "A String", # A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. + "attributionToken": "A String", # A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios. "correctedQuery": "A String", # Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search. "facets": [ # Results of facets requested by user. { # A facet result. @@ -1174,6 +1174,7 @@

Method Details

"numberConstraint": { # Constraint expression of a number field. Example: price < 100. # Numerical constraint expression. "comparison": "A String", # The comparison operation performed between the field value and the value specified in the constraint. "fieldName": "A String", # Name of the numerical field as defined in the schema. + "querySegment": "A String", # Identifies the keywords within the search query that match a filter. "value": 3.14, # The value specified in the numerical constraint. }, "orExpr": { # Logical `Or` operator. # Logical "Or" compound operator connecting multiple expressions. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.html index 411b26f5dbe..643a9f05d55 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.html @@ -85,18 +85,19 @@

Instance Methods

Returns the operations Resource.

- batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None)

+ batchGetDocumentsMetadata(parent, matcher_fhirMatcher_fhirResources=None, matcher_urisMatcher_uris=None, x__xgafv=None)

Gets index freshness metadata for Documents. Supported for website search only.

close()

Close httplib2 connections.

Method Details

- batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None) + batchGetDocumentsMetadata(parent, matcher_fhirMatcher_fhirResources=None, matcher_urisMatcher_uris=None, x__xgafv=None)
Gets index freshness metadata for Documents. Supported for website search only.
 
 Args:
   parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. (required)
+  matcher_fhirMatcher_fhirResources: string, Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} (repeated)
   matcher_urisMatcher_uris: string, The exact URIs to match by. (repeated)
   x__xgafv: string, V1 error format.
     Allowed values
@@ -109,8 +110,10 @@ 

Method Details

{ # Response message for DocumentService.BatchGetDocumentsMetadata method. "documentsMetadata": [ # The metadata of the Documents. { # The metadata of a Document. + "dataIngestionSource": "A String", # The data ingestion source of the Document. Allowed values are: * `batch`: Data ingested via Batch API, e.g., ImportDocuments. * `streaming` Data ingested via Streaming API, e.g., FHIR streaming. "lastRefreshedTime": "A String", # The timestamp of the last time the Document was last indexed. "matcherValue": { # The value of the matcher that was used to match the Document. # The value of the matcher that was used to match the Document. + "fhirResource": "A String", # Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} "uri": "A String", # If match by URI, the URI of the Document. }, "status": "A String", # The status of the document. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html index ecd2da96bad..c8d3120dad1 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -1066,7 +1066,7 @@

Method Details

"appliedControls": [ # Controls applied as part of the Control service. "A String", ], - "attributionToken": "A String", # A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. + "attributionToken": "A String", # A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios. "correctedQuery": "A String", # Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search. "facets": [ # Results of facets requested by user. { # A facet result. @@ -1123,6 +1123,7 @@

Method Details

"numberConstraint": { # Constraint expression of a number field. Example: price < 100. # Numerical constraint expression. "comparison": "A String", # The comparison operation performed between the field value and the value specified in the constraint. "fieldName": "A String", # Name of the numerical field as defined in the schema. + "querySegment": "A String", # Identifies the keywords within the search query that match a filter. "value": 3.14, # The value specified in the numerical constraint. }, "orExpr": { # Logical `Or` operator. # Logical "Or" compound operator connecting multiple expressions. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html index e509d9cc627..48a61572e12 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -1066,7 +1066,7 @@

Method Details

"appliedControls": [ # Controls applied as part of the Control service. "A String", ], - "attributionToken": "A String", # A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. + "attributionToken": "A String", # A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios. "correctedQuery": "A String", # Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search. "facets": [ # Results of facets requested by user. { # A facet result. @@ -1123,6 +1123,7 @@

Method Details

"numberConstraint": { # Constraint expression of a number field. Example: price < 100. # Numerical constraint expression. "comparison": "A String", # The comparison operation performed between the field value and the value specified in the constraint. "fieldName": "A String", # Name of the numerical field as defined in the schema. + "querySegment": "A String", # Identifies the keywords within the search query that match a filter. "value": 3.14, # The value specified in the numerical constraint. }, "orExpr": { # Logical `Or` operator. # Logical "Or" compound operator connecting multiple expressions. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.html index 18f192f047a..4c751e966c8 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.html @@ -85,18 +85,19 @@

Instance Methods

Returns the operations Resource.

- batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None)

+ batchGetDocumentsMetadata(parent, matcher_fhirMatcher_fhirResources=None, matcher_urisMatcher_uris=None, x__xgafv=None)

Gets index freshness metadata for Documents. Supported for website search only.

close()

Close httplib2 connections.

Method Details

- batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None) + batchGetDocumentsMetadata(parent, matcher_fhirMatcher_fhirResources=None, matcher_urisMatcher_uris=None, x__xgafv=None)
Gets index freshness metadata for Documents. Supported for website search only.
 
 Args:
   parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. (required)
+  matcher_fhirMatcher_fhirResources: string, Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} (repeated)
   matcher_urisMatcher_uris: string, The exact URIs to match by. (repeated)
   x__xgafv: string, V1 error format.
     Allowed values
@@ -109,8 +110,10 @@ 

Method Details

{ # Response message for DocumentService.BatchGetDocumentsMetadata method. "documentsMetadata": [ # The metadata of the Documents. { # The metadata of a Document. + "dataIngestionSource": "A String", # The data ingestion source of the Document. Allowed values are: * `batch`: Data ingested via Batch API, e.g., ImportDocuments. * `streaming` Data ingested via Streaming API, e.g., FHIR streaming. "lastRefreshedTime": "A String", # The timestamp of the last time the Document was last indexed. "matcherValue": { # The value of the matcher that was used to match the Document. # The value of the matcher that was used to match the Document. + "fhirResource": "A String", # Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} "uri": "A String", # If match by URI, the URI of the Document. }, "status": "A String", # The status of the document. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index c195c085adc..ba2ea5534ed 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -1066,7 +1066,7 @@

Method Details

"appliedControls": [ # Controls applied as part of the Control service. "A String", ], - "attributionToken": "A String", # A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. + "attributionToken": "A String", # A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios. "correctedQuery": "A String", # Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search. "facets": [ # Results of facets requested by user. { # A facet result. @@ -1123,6 +1123,7 @@

Method Details

"numberConstraint": { # Constraint expression of a number field. Example: price < 100. # Numerical constraint expression. "comparison": "A String", # The comparison operation performed between the field value and the value specified in the constraint. "fieldName": "A String", # Name of the numerical field as defined in the schema. + "querySegment": "A String", # Identifies the keywords within the search query that match a filter. "value": 3.14, # The value specified in the numerical constraint. }, "orExpr": { # Logical `Or` operator. # Logical "Or" compound operator connecting multiple expressions. diff --git a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html index 99a1244c303..10e06423e79 100644 --- a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html @@ -722,7 +722,7 @@

Method Details

Args: parent: string, Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. (required) - filter: string, Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like "gs://bucket". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = "gs://mybucket"` The length of this field should be no more than 500 characters. + filter: string, Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like "gs://bucket". - `data_source_type` - The profile's data source type, like "google/storage/bucket". - `data_storage_location` - The location where the file store's data is stored, like "us-central1". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = "gs://mybucket"` The length of this field should be no more than 500 characters. orderBy: string, Optional. Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created. pageSize: integer, Optional. Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. pageToken: string, Optional. Page token to continue retrieval. diff --git a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html index 778d909dd11..36a3a65ef8a 100644 --- a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html @@ -722,7 +722,7 @@

Method Details

Args: parent: string, Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. (required) - filter: string, Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like "gs://bucket". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = "gs://mybucket"` The length of this field should be no more than 500 characters. + filter: string, Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like "gs://bucket". - `data_source_type` - The profile's data source type, like "google/storage/bucket". - `data_storage_location` - The location where the file store's data is stored, like "us-central1". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = "gs://mybucket"` The length of this field should be no more than 500 characters. orderBy: string, Optional. Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created. pageSize: integer, Optional. Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. pageToken: string, Optional. Page token to continue retrieval. diff --git a/docs/dyn/firebasedynamiclinks_v1.v1.html b/docs/dyn/firebasedynamiclinks_v1.v1.html index d92010df4e2..22800e1e23b 100644 --- a/docs/dyn/firebasedynamiclinks_v1.v1.html +++ b/docs/dyn/firebasedynamiclinks_v1.v1.html @@ -116,6 +116,13 @@

Method Details

"platform": "A String", # Requested platform. }, ], + "warnings": [ # Optional warnings associated this API request. + { # Dynamic Links warning messages. + "warningCode": "A String", # The warning code. + "warningDocumentLink": "A String", # The document describing the warning, and helps resolve. + "warningMessage": "A String", # The warning message to help developers improve their requests. + }, + ], }
@@ -206,6 +213,13 @@

Method Details

"utmMedium": "A String", # Scion medium value to be propagated by iSDK to Scion at app-reopen. "utmSource": "A String", # Scion source value to be propagated by iSDK to Scion at app-reopen. "utmTerm": "A String", # Scion term value to be propagated by iSDK to Scion at app-reopen. + "warning": [ # Optional warnings associated this API request. + { # Dynamic Links warning messages. + "warningCode": "A String", # The warning code. + "warningDocumentLink": "A String", # The document describing the warning, and helps resolve. + "warningMessage": "A String", # The warning message to help developers improve their requests. + }, + ], }
diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html index 77a5c05a690..a25d9d97ade 100644 --- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -118,7 +118,7 @@

Method Details

}, "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "response": { # Required. The function response in JSON object format. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -155,7 +155,7 @@

Method Details

}, "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "response": { # Required. The function response in JSON object format. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -178,7 +178,7 @@

Method Details

{ # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. - "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} @@ -206,7 +206,7 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} @@ -304,7 +304,7 @@

Method Details

}, "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "response": { # Required. The function response in JSON object format. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -328,7 +328,7 @@

Method Details

"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} @@ -394,7 +394,7 @@

Method Details

}, "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "response": { # Required. The function response in JSON object format. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -425,7 +425,7 @@

Method Details

{ # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. - "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} @@ -453,7 +453,7 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} @@ -553,7 +553,7 @@

Method Details

}, "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "response": { # Required. The function response in JSON object format. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -640,9 +640,10 @@

Method Details

], }, "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). + "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). "candidatesTokenCount": 42, # Number of tokens in the response(s). "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "totalTokenCount": 42, + "totalTokenCount": 42, # Total token count for prompt and response candidates. }, }
@@ -674,7 +675,7 @@

Method Details

}, "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "response": { # Required. The function response in JSON object format. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -698,7 +699,7 @@

Method Details

"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} @@ -764,7 +765,7 @@

Method Details

}, "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "response": { # Required. The function response in JSON object format. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -795,7 +796,7 @@

Method Details

{ # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. - "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} @@ -823,7 +824,7 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} @@ -923,7 +924,7 @@

Method Details

}, "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "response": { # Required. The function response in JSON object format. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1010,9 +1011,10 @@

Method Details

], }, "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). + "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). "candidatesTokenCount": 42, # Number of tokens in the response(s). "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "totalTokenCount": 42, + "totalTokenCount": 42, # Total token count for prompt and response candidates. }, }
diff --git a/docs/dyn/gkehub_v1.projects.locations.features.html b/docs/dyn/gkehub_v1.projects.locations.features.html index 8cc170cc785..83d2eb9b309 100644 --- a/docs/dyn/gkehub_v1.projects.locations.features.html +++ b/docs/dyn/gkehub_v1.projects.locations.features.html @@ -119,7 +119,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Feature represents the settings and status of any Hub Feature. +{ # Feature represents the settings and status of any Fleet Feature. "createTime": "A String", # Output only. When the Feature resource was created. "deleteTime": "A String", # Output only. When the Feature resource was deleted. "fleetDefaultMemberConfig": { # CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet # Optional. Feature configuration applicable to all memberships of the fleet. @@ -149,7 +149,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -317,7 +317,7 @@

Method Details

"a_key": "A String", }, "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. - "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. NOTE: Please use snake case in your feature name. + "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. "configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "cluster": "A String", # The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. @@ -344,7 +344,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -637,7 +637,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -833,7 +833,7 @@

Method Details

}, }, "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. - "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself. + "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Fleet and across Memberships. # Output only. State of the Feature resource itself. "state": "A String", # The current state of the Feature resource in the Hub API. }, "scopeSpecs": { # Optional. Scope-specific configuration for this Feature. If this Feature does not support any per-Scope configuration, this field may be unused. The keys indicate which Scope the configuration is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Scope is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. @@ -849,7 +849,7 @@

Method Details

}, }, }, - "spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. + "spec": { # CommonFeatureSpec contains Fleet-wide configuration information # Optional. Fleet-wide Feature configuration. If this Feature does not support any Fleet-wide configuration, this field may be unused. "appdevexperience": { # Spec for App Dev Experience Feature. # Appdevexperience specific spec. }, "clusterupgrade": { # **ClusterUpgrade**: The configuration for the fleet-level ClusterUpgrade feature. # ClusterUpgrade (fleet-based) feature spec. @@ -888,7 +888,7 @@

Method Details

"configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` }, }, - "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. + "state": { # CommonFeatureState contains Fleet-wide Feature status information. # Output only. The Fleet-wide Feature state. "appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state. "networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources. "code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state. @@ -965,7 +965,7 @@

Method Details

}, }, }, - "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Hub. + "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Fleet. "code": "A String", # The high-level, machine-readable status of this Feature. "description": "A String", # A human-readable description of the current status. "updateTime": "A String", # The time this status and any related Feature-specific details were updated. @@ -1060,7 +1060,7 @@

Method Details

Returns: An object of the form: - { # Feature represents the settings and status of any Hub Feature. + { # Feature represents the settings and status of any Fleet Feature. "createTime": "A String", # Output only. When the Feature resource was created. "deleteTime": "A String", # Output only. When the Feature resource was deleted. "fleetDefaultMemberConfig": { # CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet # Optional. Feature configuration applicable to all memberships of the fleet. @@ -1090,7 +1090,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -1258,7 +1258,7 @@

Method Details

"a_key": "A String", }, "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. - "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. NOTE: Please use snake case in your feature name. + "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. "configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "cluster": "A String", # The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. @@ -1285,7 +1285,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -1578,7 +1578,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -1774,7 +1774,7 @@

Method Details

}, }, "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. - "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself. + "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Fleet and across Memberships. # Output only. State of the Feature resource itself. "state": "A String", # The current state of the Feature resource in the Hub API. }, "scopeSpecs": { # Optional. Scope-specific configuration for this Feature. If this Feature does not support any per-Scope configuration, this field may be unused. The keys indicate which Scope the configuration is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Scope is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. @@ -1790,7 +1790,7 @@

Method Details

}, }, }, - "spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. + "spec": { # CommonFeatureSpec contains Fleet-wide configuration information # Optional. Fleet-wide Feature configuration. If this Feature does not support any Fleet-wide configuration, this field may be unused. "appdevexperience": { # Spec for App Dev Experience Feature. # Appdevexperience specific spec. }, "clusterupgrade": { # **ClusterUpgrade**: The configuration for the fleet-level ClusterUpgrade feature. # ClusterUpgrade (fleet-based) feature spec. @@ -1829,7 +1829,7 @@

Method Details

"configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` }, }, - "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. + "state": { # CommonFeatureState contains Fleet-wide Feature status information. # Output only. The Fleet-wide Feature state. "appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state. "networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources. "code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state. @@ -1906,7 +1906,7 @@

Method Details

}, }, }, - "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Hub. + "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Fleet. "code": "A String", # The high-level, machine-readable status of this Feature. "description": "A String", # A human-readable description of the current status. "updateTime": "A String", # The time this status and any related Feature-specific details were updated. @@ -1989,7 +1989,7 @@

Method Details

{ # Response message for the `GkeHub.ListFeatures` method. "nextPageToken": "A String", # A token to request the next page of resources from the `ListFeatures` method. The value of an empty string means that there are no more resources to return. "resources": [ # The list of matching Features - { # Feature represents the settings and status of any Hub Feature. + { # Feature represents the settings and status of any Fleet Feature. "createTime": "A String", # Output only. When the Feature resource was created. "deleteTime": "A String", # Output only. When the Feature resource was deleted. "fleetDefaultMemberConfig": { # CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet # Optional. Feature configuration applicable to all memberships of the fleet. @@ -2019,7 +2019,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -2187,7 +2187,7 @@

Method Details

"a_key": "A String", }, "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. - "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. NOTE: Please use snake case in your feature name. + "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. "configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "cluster": "A String", # The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. @@ -2214,7 +2214,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -2507,7 +2507,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -2703,7 +2703,7 @@

Method Details

}, }, "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. - "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself. + "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Fleet and across Memberships. # Output only. State of the Feature resource itself. "state": "A String", # The current state of the Feature resource in the Hub API. }, "scopeSpecs": { # Optional. Scope-specific configuration for this Feature. If this Feature does not support any per-Scope configuration, this field may be unused. The keys indicate which Scope the configuration is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Scope is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. @@ -2719,7 +2719,7 @@

Method Details

}, }, }, - "spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. + "spec": { # CommonFeatureSpec contains Fleet-wide configuration information # Optional. Fleet-wide Feature configuration. If this Feature does not support any Fleet-wide configuration, this field may be unused. "appdevexperience": { # Spec for App Dev Experience Feature. # Appdevexperience specific spec. }, "clusterupgrade": { # **ClusterUpgrade**: The configuration for the fleet-level ClusterUpgrade feature. # ClusterUpgrade (fleet-based) feature spec. @@ -2758,7 +2758,7 @@

Method Details

"configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` }, }, - "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. + "state": { # CommonFeatureState contains Fleet-wide Feature status information. # Output only. The Fleet-wide Feature state. "appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state. "networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources. "code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state. @@ -2835,7 +2835,7 @@

Method Details

}, }, }, - "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Hub. + "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Fleet. "code": "A String", # The high-level, machine-readable status of this Feature. "description": "A String", # A human-readable description of the current status. "updateTime": "A String", # The time this status and any related Feature-specific details were updated. @@ -2873,7 +2873,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Feature represents the settings and status of any Hub Feature. +{ # Feature represents the settings and status of any Fleet Feature. "createTime": "A String", # Output only. When the Feature resource was created. "deleteTime": "A String", # Output only. When the Feature resource was deleted. "fleetDefaultMemberConfig": { # CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet # Optional. Feature configuration applicable to all memberships of the fleet. @@ -2903,7 +2903,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -3071,7 +3071,7 @@

Method Details

"a_key": "A String", }, "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. - "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. NOTE: Please use snake case in your feature name. + "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. "configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "cluster": "A String", # The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. @@ -3098,7 +3098,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -3391,7 +3391,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -3587,7 +3587,7 @@

Method Details

}, }, "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. - "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself. + "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Fleet and across Memberships. # Output only. State of the Feature resource itself. "state": "A String", # The current state of the Feature resource in the Hub API. }, "scopeSpecs": { # Optional. Scope-specific configuration for this Feature. If this Feature does not support any per-Scope configuration, this field may be unused. The keys indicate which Scope the configuration is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Scope is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. @@ -3603,7 +3603,7 @@

Method Details

}, }, }, - "spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. + "spec": { # CommonFeatureSpec contains Fleet-wide configuration information # Optional. Fleet-wide Feature configuration. If this Feature does not support any Fleet-wide configuration, this field may be unused. "appdevexperience": { # Spec for App Dev Experience Feature. # Appdevexperience specific spec. }, "clusterupgrade": { # **ClusterUpgrade**: The configuration for the fleet-level ClusterUpgrade feature. # ClusterUpgrade (fleet-based) feature spec. @@ -3642,7 +3642,7 @@

Method Details

"configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` }, }, - "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. + "state": { # CommonFeatureState contains Fleet-wide Feature status information. # Output only. The Fleet-wide Feature state. "appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state. "networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources. "code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state. @@ -3719,7 +3719,7 @@

Method Details

}, }, }, - "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Hub. + "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Fleet. "code": "A String", # The high-level, machine-readable status of this Feature. "description": "A String", # A human-readable description of the current status. "updateTime": "A String", # The time this status and any related Feature-specific details were updated. diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.features.html b/docs/dyn/gkehub_v1alpha.projects.locations.features.html index cf2ce722ba3..51fdb42631c 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.features.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.features.html @@ -119,7 +119,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Feature represents the settings and status of any Hub Feature. +{ # Feature represents the settings and status of any Fleet Feature. "createTime": "A String", # Output only. When the Feature resource was created. "deleteTime": "A String", # Output only. When the Feature resource was deleted. "fleetDefaultMemberConfig": { # CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet # Optional. Feature configuration applicable to all memberships of the fleet. @@ -152,7 +152,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -322,7 +322,7 @@

Method Details

"a_key": "A String", }, "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. - "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. NOTE: Please use snake case in your feature name. + "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. "anthosobservability": { # **Anthosobservability**: Per-Membership Feature spec. # Anthos Observability-specific spec "doNotOptimizeMetrics": True or False, # Use full of metrics rather than optimized metrics. See https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics "enableStackdriverOnApplications": True or False, # Enable collecting and reporting metrics and logs from user apps. @@ -361,7 +361,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -673,7 +673,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -895,7 +895,7 @@

Method Details

}, }, "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. - "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself. + "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Fleet and across Memberships. # Output only. State of the Feature resource itself. "state": "A String", # The current state of the Feature resource in the Hub API. }, "scopeSpecs": { # Optional. Scope-specific configuration for this Feature. If this Feature does not support any per-Scope configuration, this field may be unused. The keys indicate which Scope the configuration is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Scope is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. @@ -967,7 +967,7 @@

Method Details

}, }, }, - "spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. + "spec": { # CommonFeatureSpec contains Fleet-wide configuration information # Optional. Fleet-wide Feature configuration. If this Feature does not support any Fleet-wide configuration, this field may be unused. "anthosobservability": { # **Anthos Observability**: Spec # Anthos Observability spec "defaultMembershipSpec": { # **Anthosobservability**: Per-Membership Feature spec. # Default membership spec for unconfigured memberships "doNotOptimizeMetrics": True or False, # Use full of metrics rather than optimized metrics. See https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics @@ -1028,7 +1028,7 @@

Method Details

"provisionGoogleCa": "A String", # Immutable. Specifies CA configuration. }, }, - "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. + "state": { # CommonFeatureState contains Fleet-wide Feature status information. # Output only. The Fleet-wide Feature state. "appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state. "networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources. "code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state. @@ -1128,7 +1128,7 @@

Method Details

}, ], }, - "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Hub. + "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Fleet. "code": "A String", # The high-level, machine-readable status of this Feature. "description": "A String", # A human-readable description of the current status. "updateTime": "A String", # The time this status and any related Feature-specific details were updated. @@ -1223,7 +1223,7 @@

Method Details

Returns: An object of the form: - { # Feature represents the settings and status of any Hub Feature. + { # Feature represents the settings and status of any Fleet Feature. "createTime": "A String", # Output only. When the Feature resource was created. "deleteTime": "A String", # Output only. When the Feature resource was deleted. "fleetDefaultMemberConfig": { # CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet # Optional. Feature configuration applicable to all memberships of the fleet. @@ -1256,7 +1256,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -1426,7 +1426,7 @@

Method Details

"a_key": "A String", }, "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. - "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. NOTE: Please use snake case in your feature name. + "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. "anthosobservability": { # **Anthosobservability**: Per-Membership Feature spec. # Anthos Observability-specific spec "doNotOptimizeMetrics": True or False, # Use full of metrics rather than optimized metrics. See https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics "enableStackdriverOnApplications": True or False, # Enable collecting and reporting metrics and logs from user apps. @@ -1465,7 +1465,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -1777,7 +1777,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -1999,7 +1999,7 @@

Method Details

}, }, "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. - "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself. + "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Fleet and across Memberships. # Output only. State of the Feature resource itself. "state": "A String", # The current state of the Feature resource in the Hub API. }, "scopeSpecs": { # Optional. Scope-specific configuration for this Feature. If this Feature does not support any per-Scope configuration, this field may be unused. The keys indicate which Scope the configuration is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Scope is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. @@ -2071,7 +2071,7 @@

Method Details

}, }, }, - "spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. + "spec": { # CommonFeatureSpec contains Fleet-wide configuration information # Optional. Fleet-wide Feature configuration. If this Feature does not support any Fleet-wide configuration, this field may be unused. "anthosobservability": { # **Anthos Observability**: Spec # Anthos Observability spec "defaultMembershipSpec": { # **Anthosobservability**: Per-Membership Feature spec. # Default membership spec for unconfigured memberships "doNotOptimizeMetrics": True or False, # Use full of metrics rather than optimized metrics. See https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics @@ -2132,7 +2132,7 @@

Method Details

"provisionGoogleCa": "A String", # Immutable. Specifies CA configuration. }, }, - "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. + "state": { # CommonFeatureState contains Fleet-wide Feature status information. # Output only. The Fleet-wide Feature state. "appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state. "networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources. "code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state. @@ -2232,7 +2232,7 @@

Method Details

}, ], }, - "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Hub. + "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Fleet. "code": "A String", # The high-level, machine-readable status of this Feature. "description": "A String", # A human-readable description of the current status. "updateTime": "A String", # The time this status and any related Feature-specific details were updated. @@ -2315,7 +2315,7 @@

Method Details

{ # Response message for the `GkeHub.ListFeatures` method. "nextPageToken": "A String", # A token to request the next page of resources from the `ListFeatures` method. The value of an empty string means that there are no more resources to return. "resources": [ # The list of matching Features - { # Feature represents the settings and status of any Hub Feature. + { # Feature represents the settings and status of any Fleet Feature. "createTime": "A String", # Output only. When the Feature resource was created. "deleteTime": "A String", # Output only. When the Feature resource was deleted. "fleetDefaultMemberConfig": { # CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet # Optional. Feature configuration applicable to all memberships of the fleet. @@ -2348,7 +2348,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -2518,7 +2518,7 @@

Method Details

"a_key": "A String", }, "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. - "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. NOTE: Please use snake case in your feature name. + "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. "anthosobservability": { # **Anthosobservability**: Per-Membership Feature spec. # Anthos Observability-specific spec "doNotOptimizeMetrics": True or False, # Use full of metrics rather than optimized metrics. See https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics "enableStackdriverOnApplications": True or False, # Enable collecting and reporting metrics and logs from user apps. @@ -2557,7 +2557,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -2869,7 +2869,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -3091,7 +3091,7 @@

Method Details

}, }, "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. - "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself. + "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Fleet and across Memberships. # Output only. State of the Feature resource itself. "state": "A String", # The current state of the Feature resource in the Hub API. }, "scopeSpecs": { # Optional. Scope-specific configuration for this Feature. If this Feature does not support any per-Scope configuration, this field may be unused. The keys indicate which Scope the configuration is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Scope is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. @@ -3163,7 +3163,7 @@

Method Details

}, }, }, - "spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. + "spec": { # CommonFeatureSpec contains Fleet-wide configuration information # Optional. Fleet-wide Feature configuration. If this Feature does not support any Fleet-wide configuration, this field may be unused. "anthosobservability": { # **Anthos Observability**: Spec # Anthos Observability spec "defaultMembershipSpec": { # **Anthosobservability**: Per-Membership Feature spec. # Default membership spec for unconfigured memberships "doNotOptimizeMetrics": True or False, # Use full of metrics rather than optimized metrics. See https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics @@ -3224,7 +3224,7 @@

Method Details

"provisionGoogleCa": "A String", # Immutable. Specifies CA configuration. }, }, - "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. + "state": { # CommonFeatureState contains Fleet-wide Feature status information. # Output only. The Fleet-wide Feature state. "appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state. "networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources. "code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state. @@ -3324,7 +3324,7 @@

Method Details

}, ], }, - "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Hub. + "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Fleet. "code": "A String", # The high-level, machine-readable status of this Feature. "description": "A String", # A human-readable description of the current status. "updateTime": "A String", # The time this status and any related Feature-specific details were updated. @@ -3362,7 +3362,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Feature represents the settings and status of any Hub Feature. +{ # Feature represents the settings and status of any Fleet Feature. "createTime": "A String", # Output only. When the Feature resource was created. "deleteTime": "A String", # Output only. When the Feature resource was deleted. "fleetDefaultMemberConfig": { # CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet # Optional. Feature configuration applicable to all memberships of the fleet. @@ -3395,7 +3395,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -3565,7 +3565,7 @@

Method Details

"a_key": "A String", }, "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. - "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. NOTE: Please use snake case in your feature name. + "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. "anthosobservability": { # **Anthosobservability**: Per-Membership Feature spec. # Anthos Observability-specific spec "doNotOptimizeMetrics": True or False, # Use full of metrics rather than optimized metrics. See https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics "enableStackdriverOnApplications": True or False, # Enable collecting and reporting metrics and logs from user apps. @@ -3604,7 +3604,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -3916,7 +3916,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -4138,7 +4138,7 @@

Method Details

}, }, "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. - "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself. + "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Fleet and across Memberships. # Output only. State of the Feature resource itself. "state": "A String", # The current state of the Feature resource in the Hub API. }, "scopeSpecs": { # Optional. Scope-specific configuration for this Feature. If this Feature does not support any per-Scope configuration, this field may be unused. The keys indicate which Scope the configuration is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Scope is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. @@ -4210,7 +4210,7 @@

Method Details

}, }, }, - "spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. + "spec": { # CommonFeatureSpec contains Fleet-wide configuration information # Optional. Fleet-wide Feature configuration. If this Feature does not support any Fleet-wide configuration, this field may be unused. "anthosobservability": { # **Anthos Observability**: Spec # Anthos Observability spec "defaultMembershipSpec": { # **Anthosobservability**: Per-Membership Feature spec. # Default membership spec for unconfigured memberships "doNotOptimizeMetrics": True or False, # Use full of metrics rather than optimized metrics. See https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics @@ -4271,7 +4271,7 @@

Method Details

"provisionGoogleCa": "A String", # Immutable. Specifies CA configuration. }, }, - "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. + "state": { # CommonFeatureState contains Fleet-wide Feature status information. # Output only. The Fleet-wide Feature state. "appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state. "networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources. "code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state. @@ -4371,7 +4371,7 @@

Method Details

}, ], }, - "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Hub. + "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Fleet. "code": "A String", # The high-level, machine-readable status of this Feature. "description": "A String", # A human-readable description of the current status. "updateTime": "A String", # The time this status and any related Feature-specific details were updated. diff --git a/docs/dyn/gkehub_v1beta.projects.locations.features.html b/docs/dyn/gkehub_v1beta.projects.locations.features.html index ae6be2d2892..bf3fa300bf6 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.features.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.features.html @@ -119,7 +119,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Feature represents the settings and status of any Hub Feature. +{ # Feature represents the settings and status of any Fleet Feature. "createTime": "A String", # Output only. When the Feature resource was created. "deleteTime": "A String", # Output only. When the Feature resource was deleted. "fleetDefaultMemberConfig": { # CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet # Optional. Feature configuration applicable to all memberships of the fleet. @@ -152,7 +152,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -320,7 +320,7 @@

Method Details

"a_key": "A String", }, "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. - "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. NOTE: Please use snake case in your feature name. + "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. "anthosobservability": { # **Anthosobservability**: Per-Membership Feature spec. # Anthos Observability-specific spec "doNotOptimizeMetrics": True or False, # Use full of metrics rather than optimized metrics. See https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics "enableStackdriverOnApplications": True or False, # Enable collecting and reporting metrics and logs from user apps. @@ -359,7 +359,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -661,7 +661,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -861,7 +861,7 @@

Method Details

}, }, "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. - "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself. + "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Fleet and across Memberships. # Output only. State of the Feature resource itself. "state": "A String", # The current state of the Feature resource in the Hub API. }, "scopeSpecs": { # Optional. Scope-specific configuration for this Feature. If this Feature does not support any per-Scope configuration, this field may be unused. The keys indicate which Scope the configuration is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Scope is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. @@ -877,7 +877,7 @@

Method Details

}, }, }, - "spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. + "spec": { # CommonFeatureSpec contains Fleet-wide configuration information # Optional. Fleet-wide Feature configuration. If this Feature does not support any Fleet-wide configuration, this field may be unused. "anthosobservability": { # **Anthos Observability**: Spec # Anthos Observability spec "defaultMembershipSpec": { # **Anthosobservability**: Per-Membership Feature spec. # Default membership spec for unconfigured memberships "doNotOptimizeMetrics": True or False, # Use full of metrics rather than optimized metrics. See https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics @@ -924,7 +924,7 @@

Method Details

"configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` }, }, - "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. + "state": { # CommonFeatureState contains Fleet-wide Feature status information. # Output only. The Fleet-wide Feature state. "appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state. "networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources. "code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state. @@ -1001,7 +1001,7 @@

Method Details

}, }, }, - "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Hub. + "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Fleet. "code": "A String", # The high-level, machine-readable status of this Feature. "description": "A String", # A human-readable description of the current status. "updateTime": "A String", # The time this status and any related Feature-specific details were updated. @@ -1096,7 +1096,7 @@

Method Details

Returns: An object of the form: - { # Feature represents the settings and status of any Hub Feature. + { # Feature represents the settings and status of any Fleet Feature. "createTime": "A String", # Output only. When the Feature resource was created. "deleteTime": "A String", # Output only. When the Feature resource was deleted. "fleetDefaultMemberConfig": { # CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet # Optional. Feature configuration applicable to all memberships of the fleet. @@ -1129,7 +1129,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -1297,7 +1297,7 @@

Method Details

"a_key": "A String", }, "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. - "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. NOTE: Please use snake case in your feature name. + "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. "anthosobservability": { # **Anthosobservability**: Per-Membership Feature spec. # Anthos Observability-specific spec "doNotOptimizeMetrics": True or False, # Use full of metrics rather than optimized metrics. See https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics "enableStackdriverOnApplications": True or False, # Enable collecting and reporting metrics and logs from user apps. @@ -1336,7 +1336,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -1638,7 +1638,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -1838,7 +1838,7 @@

Method Details

}, }, "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. - "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself. + "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Fleet and across Memberships. # Output only. State of the Feature resource itself. "state": "A String", # The current state of the Feature resource in the Hub API. }, "scopeSpecs": { # Optional. Scope-specific configuration for this Feature. If this Feature does not support any per-Scope configuration, this field may be unused. The keys indicate which Scope the configuration is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Scope is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. @@ -1854,7 +1854,7 @@

Method Details

}, }, }, - "spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. + "spec": { # CommonFeatureSpec contains Fleet-wide configuration information # Optional. Fleet-wide Feature configuration. If this Feature does not support any Fleet-wide configuration, this field may be unused. "anthosobservability": { # **Anthos Observability**: Spec # Anthos Observability spec "defaultMembershipSpec": { # **Anthosobservability**: Per-Membership Feature spec. # Default membership spec for unconfigured memberships "doNotOptimizeMetrics": True or False, # Use full of metrics rather than optimized metrics. See https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics @@ -1901,7 +1901,7 @@

Method Details

"configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` }, }, - "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. + "state": { # CommonFeatureState contains Fleet-wide Feature status information. # Output only. The Fleet-wide Feature state. "appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state. "networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources. "code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state. @@ -1978,7 +1978,7 @@

Method Details

}, }, }, - "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Hub. + "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Fleet. "code": "A String", # The high-level, machine-readable status of this Feature. "description": "A String", # A human-readable description of the current status. "updateTime": "A String", # The time this status and any related Feature-specific details were updated. @@ -2061,7 +2061,7 @@

Method Details

{ # Response message for the `GkeHub.ListFeatures` method. "nextPageToken": "A String", # A token to request the next page of resources from the `ListFeatures` method. The value of an empty string means that there are no more resources to return. "resources": [ # The list of matching Features - { # Feature represents the settings and status of any Hub Feature. + { # Feature represents the settings and status of any Fleet Feature. "createTime": "A String", # Output only. When the Feature resource was created. "deleteTime": "A String", # Output only. When the Feature resource was deleted. "fleetDefaultMemberConfig": { # CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet # Optional. Feature configuration applicable to all memberships of the fleet. @@ -2094,7 +2094,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -2262,7 +2262,7 @@

Method Details

"a_key": "A String", }, "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. - "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. NOTE: Please use snake case in your feature name. + "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. "anthosobservability": { # **Anthosobservability**: Per-Membership Feature spec. # Anthos Observability-specific spec "doNotOptimizeMetrics": True or False, # Use full of metrics rather than optimized metrics. See https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics "enableStackdriverOnApplications": True or False, # Enable collecting and reporting metrics and logs from user apps. @@ -2301,7 +2301,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -2603,7 +2603,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -2803,7 +2803,7 @@

Method Details

}, }, "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. - "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself. + "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Fleet and across Memberships. # Output only. State of the Feature resource itself. "state": "A String", # The current state of the Feature resource in the Hub API. }, "scopeSpecs": { # Optional. Scope-specific configuration for this Feature. If this Feature does not support any per-Scope configuration, this field may be unused. The keys indicate which Scope the configuration is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Scope is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. @@ -2819,7 +2819,7 @@

Method Details

}, }, }, - "spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. + "spec": { # CommonFeatureSpec contains Fleet-wide configuration information # Optional. Fleet-wide Feature configuration. If this Feature does not support any Fleet-wide configuration, this field may be unused. "anthosobservability": { # **Anthos Observability**: Spec # Anthos Observability spec "defaultMembershipSpec": { # **Anthosobservability**: Per-Membership Feature spec. # Default membership spec for unconfigured memberships "doNotOptimizeMetrics": True or False, # Use full of metrics rather than optimized metrics. See https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics @@ -2866,7 +2866,7 @@

Method Details

"configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` }, }, - "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. + "state": { # CommonFeatureState contains Fleet-wide Feature status information. # Output only. The Fleet-wide Feature state. "appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state. "networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources. "code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state. @@ -2943,7 +2943,7 @@

Method Details

}, }, }, - "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Hub. + "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Fleet. "code": "A String", # The high-level, machine-readable status of this Feature. "description": "A String", # A human-readable description of the current status. "updateTime": "A String", # The time this status and any related Feature-specific details were updated. @@ -2981,7 +2981,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Feature represents the settings and status of any Hub Feature. +{ # Feature represents the settings and status of any Fleet Feature. "createTime": "A String", # Output only. When the Feature resource was created. "deleteTime": "A String", # Output only. When the Feature resource was deleted. "fleetDefaultMemberConfig": { # CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet # Optional. Feature configuration applicable to all memberships of the fleet. @@ -3014,7 +3014,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -3182,7 +3182,7 @@

Method Details

"a_key": "A String", }, "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. - "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. NOTE: Please use snake case in your feature name. + "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. "anthosobservability": { # **Anthosobservability**: Per-Membership Feature spec. # Anthos Observability-specific spec "doNotOptimizeMetrics": True or False, # Use full of metrics rather than optimized metrics. See https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics "enableStackdriverOnApplications": True or False, # Enable collecting and reporting metrics and logs from user apps. @@ -3221,7 +3221,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -3523,7 +3523,7 @@

Method Details

"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. }, - "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. + "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. @@ -3723,7 +3723,7 @@

Method Details

}, }, "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. - "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself. + "resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Fleet and across Memberships. # Output only. State of the Feature resource itself. "state": "A String", # The current state of the Feature resource in the Hub API. }, "scopeSpecs": { # Optional. Scope-specific configuration for this Feature. If this Feature does not support any per-Scope configuration, this field may be unused. The keys indicate which Scope the configuration is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Scope is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. @@ -3739,7 +3739,7 @@

Method Details

}, }, }, - "spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. + "spec": { # CommonFeatureSpec contains Fleet-wide configuration information # Optional. Fleet-wide Feature configuration. If this Feature does not support any Fleet-wide configuration, this field may be unused. "anthosobservability": { # **Anthos Observability**: Spec # Anthos Observability spec "defaultMembershipSpec": { # **Anthosobservability**: Per-Membership Feature spec. # Default membership spec for unconfigured memberships "doNotOptimizeMetrics": True or False, # Use full of metrics rather than optimized metrics. See https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics @@ -3786,7 +3786,7 @@

Method Details

"configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` }, }, - "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. + "state": { # CommonFeatureState contains Fleet-wide Feature status information. # Output only. The Fleet-wide Feature state. "appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state. "networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources. "code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state. @@ -3863,7 +3863,7 @@

Method Details

}, }, }, - "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Hub. + "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Fleet. "code": "A String", # The high-level, machine-readable status of this Feature. "description": "A String", # A human-readable description of the current status. "updateTime": "A String", # The time this status and any related Feature-specific details were updated. diff --git a/docs/dyn/gkeonprem_v1.html b/docs/dyn/gkeonprem_v1.html index fd097fbfa5f..ee38d55e8d3 100644 --- a/docs/dyn/gkeonprem_v1.html +++ b/docs/dyn/gkeonprem_v1.html @@ -72,7 +72,7 @@ -

Anthos On-Prem API

+

GDC Virtual API

Instance Methods

projects() diff --git a/docs/dyn/gkeonprem_v1.projects.html b/docs/dyn/gkeonprem_v1.projects.html index 230f666223c..c5ee41af57b 100644 --- a/docs/dyn/gkeonprem_v1.projects.html +++ b/docs/dyn/gkeonprem_v1.projects.html @@ -72,7 +72,7 @@ -

Anthos On-Prem API . projects

+

GDC Virtual API . projects

Instance Methods

locations() diff --git a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalAdminClusters.html b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalAdminClusters.html index 1364b7d4404..83acf4b3486 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalAdminClusters.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalAdminClusters.html @@ -72,7 +72,7 @@ -

Anthos On-Prem API . projects . locations . bareMetalAdminClusters

+

GDC Virtual API . projects . locations . bareMetalAdminClusters

Instance Methods

operations() @@ -83,19 +83,19 @@

Instance Methods

close()

Close httplib2 connections.

- create(parent, body, bareMetalAdminClusterId=None, validateOnly=None, x__xgafv=None)

+ create(parent, body, allowPreflightFailure=None, bareMetalAdminClusterId=None, validateOnly=None, x__xgafv=None)

Creates a new bare metal admin cluster in a given project and location. The API needs to be combined with creating a bootstrap cluster to work. See: https://cloud.google.com/anthos/clusters/docs/bare-metal/latest/installing/creating-clusters/create-admin-cluster-api#prepare_bootstrap_environment

enroll(parent, body=None, x__xgafv=None)

Enrolls an existing bare metal admin cluster to the Anthos On-Prem API within a given project and location. Through enrollment, an existing admin cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster will be expected to be performed through the API.

- get(name, view=None, x__xgafv=None)

+ get(name, allowMissing=None, view=None, x__xgafv=None)

Gets details of a single bare metal admin cluster.

getIamPolicy(resource, options_requestedPolicyVersion=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.

- list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)

+ list(parent, allowMissing=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)

Lists bare metal admin clusters in a given project and location.

list_next()

@@ -122,7 +122,7 @@

Method Details

- create(parent, body, bareMetalAdminClusterId=None, validateOnly=None, x__xgafv=None) + create(parent, body, allowPreflightFailure=None, bareMetalAdminClusterId=None, validateOnly=None, x__xgafv=None)
Creates a new bare metal admin cluster in a given project and location. The API needs to be combined with creating a bootstrap cluster to work. See: https://cloud.google.com/anthos/clusters/docs/bare-metal/latest/installing/creating-clusters/create-admin-cluster-api#prepare_bootstrap_environment
 
 Args:
@@ -265,6 +265,15 @@ 

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "storage": { # BareMetalAdminStorageConfig specifies the cluster storage configuration. # Storage configuration. "lvpNodeMountsConfig": { # Specifies the configs for local persistent volumes (PVs). # Required. Specifies the config for local PersistentVolumes backed by mounted node disks. These disks need to be formatted and mounted by the user, which can be done before or after cluster creation. @@ -298,6 +307,7 @@

Method Details

}, } + allowPreflightFailure: boolean, Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with "cluster already exists" error and hence a update cluster is required to fix the cluster. bareMetalAdminClusterId: string, Required. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/ validateOnly: boolean, Validate the request without actually doing any updates. x__xgafv: string, V1 error format. @@ -373,11 +383,12 @@

Method Details

- get(name, view=None, x__xgafv=None) + get(name, allowMissing=None, view=None, x__xgafv=None)
Gets details of a single bare metal admin cluster.
 
 Args:
   name: string, Required. Name of the bare metal admin cluster to get. Format: "projects/{project}/locations/{location}/bareMetalAdminClusters/{bare_metal_admin_cluster}" (required)
+  allowMissing: boolean, Optional. If true, return BareMetal Admin Cluster including the one that only exists in RMS.
   view: string, View for bare metal admin cluster. When `BASIC` is specified, only the cluster resource name and membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete cluster configuration details.
     Allowed values
       CLUSTER_VIEW_UNSPECIFIED - If the value is not set, the default `FULL` view is used.
@@ -526,6 +537,15 @@ 

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "storage": { # BareMetalAdminStorageConfig specifies the cluster storage configuration. # Storage configuration. "lvpNodeMountsConfig": { # Specifies the configs for local persistent volumes (PVs). # Required. Specifies the config for local PersistentVolumes backed by mounted node disks. These disks need to be formatted and mounted by the user, which can be done before or after cluster creation. @@ -596,11 +616,12 @@

Method Details

- list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None) + list(parent, allowMissing=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists bare metal admin clusters in a given project and location.
 
 Args:
   parent: string, Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}" (required)
+  allowMissing: boolean, Optional. If true, return list of BareMetal Admin Clusters including the ones that only exists in RMS.
   pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A token identifying a page of results the server should return.
   view: string, View for bare metal admin clusters. When `BASIC` is specified, only the admin cluster resource name and membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete admin cluster configuration details.
@@ -753,6 +774,15 @@ 

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "storage": { # BareMetalAdminStorageConfig specifies the cluster storage configuration. # Storage configuration. "lvpNodeMountsConfig": { # Specifies the configs for local persistent volumes (PVs). # Required. Specifies the config for local PersistentVolumes backed by mounted node disks. These disks need to be formatted and mounted by the user, which can be done before or after cluster creation. @@ -951,6 +981,15 @@

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "storage": { # BareMetalAdminStorageConfig specifies the cluster storage configuration. # Storage configuration. "lvpNodeMountsConfig": { # Specifies the configs for local persistent volumes (PVs). # Required. Specifies the config for local PersistentVolumes backed by mounted node disks. These disks need to be formatted and mounted by the user, which can be done before or after cluster creation. diff --git a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalAdminClusters.operations.html b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalAdminClusters.operations.html index a0004fc8868..7f72ce0584c 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalAdminClusters.operations.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalAdminClusters.operations.html @@ -72,7 +72,7 @@ -

Anthos On-Prem API . projects . locations . bareMetalAdminClusters . operations

+

GDC Virtual API . projects . locations . bareMetalAdminClusters . operations

Instance Methods

close()

diff --git a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.bareMetalNodePools.html b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.bareMetalNodePools.html index f1c5970514f..b6047bce577 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.bareMetalNodePools.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.bareMetalNodePools.html @@ -72,7 +72,7 @@ -

Anthos On-Prem API . projects . locations . bareMetalClusters . bareMetalNodePools

+

GDC Virtual API . projects . locations . bareMetalClusters . bareMetalNodePools

Instance Methods

operations() @@ -178,6 +178,15 @@

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "uid": "A String", # Output only. The unique identifier of the bare metal node pool. "updateTime": "A String", # Output only. The time at which this bare metal node pool was last updated. @@ -369,6 +378,15 @@

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "uid": "A String", # Output only. The unique identifier of the bare metal node pool. "updateTime": "A String", # Output only. The time at which this bare metal node pool was last updated. @@ -487,6 +505,15 @@

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "uid": "A String", # Output only. The unique identifier of the bare metal node pool. "updateTime": "A String", # Output only. The time at which this bare metal node pool was last updated. @@ -576,6 +603,15 @@

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "uid": "A String", # Output only. The unique identifier of the bare metal node pool. "updateTime": "A String", # Output only. The time at which this bare metal node pool was last updated. diff --git a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.bareMetalNodePools.operations.html b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.bareMetalNodePools.operations.html index e493fa3cbda..a6e05838cbe 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.bareMetalNodePools.operations.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.bareMetalNodePools.operations.html @@ -72,7 +72,7 @@ -

Anthos On-Prem API . projects . locations . bareMetalClusters . bareMetalNodePools . operations

+

GDC Virtual API . projects . locations . bareMetalClusters . bareMetalNodePools . operations

Instance Methods

close()

diff --git a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.html b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.html index 9febb86140d..d55622ff9b8 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.html @@ -72,7 +72,7 @@ -

Anthos On-Prem API . projects . locations . bareMetalClusters

+

GDC Virtual API . projects . locations . bareMetalClusters

Instance Methods

bareMetalNodePools() @@ -88,7 +88,7 @@

Instance Methods

close()

Close httplib2 connections.

- create(parent, body, bareMetalClusterId=None, validateOnly=None, x__xgafv=None)

+ create(parent, body, allowPreflightFailure=None, bareMetalClusterId=None, validateOnly=None, x__xgafv=None)

Creates a new bare metal cluster in a given project and location.

delete(name, allowMissing=None, etag=None, force=None, ignoreErrors=None, validateOnly=None, x__xgafv=None)

@@ -97,13 +97,13 @@

Instance Methods

enroll(parent, body=None, x__xgafv=None)

Enrolls an existing bare metal user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API.

- get(name, view=None, x__xgafv=None)

+ get(name, allowMissing=None, view=None, x__xgafv=None)

Gets details of a single bare metal Cluster.

getIamPolicy(resource, options_requestedPolicyVersion=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.

- list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)

+ list(parent, allowMissing=None, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)

Lists bare metal clusters in a given project and location.

list_next()

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

Method Details

- create(parent, body, bareMetalClusterId=None, validateOnly=None, x__xgafv=None) + create(parent, body, allowPreflightFailure=None, bareMetalClusterId=None, validateOnly=None, x__xgafv=None)
Creates a new bare metal cluster in a given project and location.
 
 Args:
@@ -374,6 +374,15 @@ 

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "storage": { # BareMetalStorageConfig specifies the cluster storage configuration. # Required. Storage configuration. "lvpNodeMountsConfig": { # Specifies the configs for local persistent volumes (PVs). # Required. Specifies the config for local PersistentVolumes backed by mounted node disks. These disks need to be formatted and mounted by the user, which can be done before or after cluster creation. @@ -391,6 +400,7 @@

Method Details

"uid": "A String", # Output only. The unique identifier of the bare metal user cluster. "updateTime": "A String", # Output only. The time when the bare metal user cluster was last updated. "upgradePolicy": { # BareMetalClusterUpgradePolicy defines the cluster upgrade policy. # The cluster upgrade policy. + "pause": True or False, # Output only. Pause is used to show the upgrade pause status. It's view only for now. "policy": "A String", # Specifies which upgrade policy to use. }, "validationCheck": { # ValidationCheck represents the result of preflight check. # Output only. The result of the preflight check. @@ -410,6 +420,7 @@

Method Details

}, } + allowPreflightFailure: boolean, Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with "cluster already exists" error and hence a update cluster is required to fix the cluster. bareMetalClusterId: string, Required. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/ validateOnly: boolean, Validate the request without actually doing any updates. x__xgafv: string, V1 error format. @@ -526,11 +537,12 @@

Method Details

- get(name, view=None, x__xgafv=None) + get(name, allowMissing=None, view=None, x__xgafv=None)
Gets details of a single bare metal Cluster.
 
 Args:
   name: string, Required. Name of the bare metal user cluster to get. Format: "projects/{project}/locations/{location}/bareMetalClusters/{bare_metal_cluster}" (required)
+  allowMissing: boolean, Optional. If true, return BareMetal Cluster including the one that only exists in RMS.
   view: string, View for bare metal user cluster. When `BASIC` is specified, only the cluster resource name and admin cluster membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete cluster configuration details.
     Allowed values
       CLUSTER_VIEW_UNSPECIFIED - If the value is not set, the default `FULL` view is used.
@@ -780,6 +792,15 @@ 

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "storage": { # BareMetalStorageConfig specifies the cluster storage configuration. # Required. Storage configuration. "lvpNodeMountsConfig": { # Specifies the configs for local persistent volumes (PVs). # Required. Specifies the config for local PersistentVolumes backed by mounted node disks. These disks need to be formatted and mounted by the user, which can be done before or after cluster creation. @@ -797,6 +818,7 @@

Method Details

"uid": "A String", # Output only. The unique identifier of the bare metal user cluster. "updateTime": "A String", # Output only. The time when the bare metal user cluster was last updated. "upgradePolicy": { # BareMetalClusterUpgradePolicy defines the cluster upgrade policy. # The cluster upgrade policy. + "pause": True or False, # Output only. Pause is used to show the upgrade pause status. It's view only for now. "policy": "A String", # Specifies which upgrade policy to use. }, "validationCheck": { # ValidationCheck represents the result of preflight check. # Output only. The result of the preflight check. @@ -853,11 +875,12 @@

Method Details

- list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None) + list(parent, allowMissing=None, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists bare metal clusters in a given project and location.
 
 Args:
   parent: string, Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}" (required)
+  allowMissing: boolean, Optional. If true, return list of BareMetal Clusters including the ones that only exists in RMS.
   filter: string, A resource filtering expression following https://google.aip.dev/160. When non-empty, only resource's whose attributes field matches the filter are returned.
   pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A token identifying a page of results the server should return.
@@ -1112,6 +1135,15 @@ 

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "storage": { # BareMetalStorageConfig specifies the cluster storage configuration. # Required. Storage configuration. "lvpNodeMountsConfig": { # Specifies the configs for local persistent volumes (PVs). # Required. Specifies the config for local PersistentVolumes backed by mounted node disks. These disks need to be formatted and mounted by the user, which can be done before or after cluster creation. @@ -1129,6 +1161,7 @@

Method Details

"uid": "A String", # Output only. The unique identifier of the bare metal user cluster. "updateTime": "A String", # Output only. The time when the bare metal user cluster was last updated. "upgradePolicy": { # BareMetalClusterUpgradePolicy defines the cluster upgrade policy. # The cluster upgrade policy. + "pause": True or False, # Output only. Pause is used to show the upgrade pause status. It's view only for now. "policy": "A String", # Specifies which upgrade policy to use. }, "validationCheck": { # ValidationCheck represents the result of preflight check. # Output only. The result of the preflight check. @@ -1414,6 +1447,15 @@

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "storage": { # BareMetalStorageConfig specifies the cluster storage configuration. # Required. Storage configuration. "lvpNodeMountsConfig": { # Specifies the configs for local persistent volumes (PVs). # Required. Specifies the config for local PersistentVolumes backed by mounted node disks. These disks need to be formatted and mounted by the user, which can be done before or after cluster creation. @@ -1431,6 +1473,7 @@

Method Details

"uid": "A String", # Output only. The unique identifier of the bare metal user cluster. "updateTime": "A String", # Output only. The time when the bare metal user cluster was last updated. "upgradePolicy": { # BareMetalClusterUpgradePolicy defines the cluster upgrade policy. # The cluster upgrade policy. + "pause": True or False, # Output only. Pause is used to show the upgrade pause status. It's view only for now. "policy": "A String", # Specifies which upgrade policy to use. }, "validationCheck": { # ValidationCheck represents the result of preflight check. # Output only. The result of the preflight check. diff --git a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.operations.html b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.operations.html index e597d744dd7..194742ea493 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.operations.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.operations.html @@ -72,7 +72,7 @@ -

Anthos On-Prem API . projects . locations . bareMetalClusters . operations

+

GDC Virtual API . projects . locations . bareMetalClusters . operations

Instance Methods

close()

diff --git a/docs/dyn/gkeonprem_v1.projects.locations.html b/docs/dyn/gkeonprem_v1.projects.locations.html index ed83f9e080e..6f8b14cbd6a 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.html @@ -72,7 +72,7 @@ -

Anthos On-Prem API . projects . locations

+

GDC Virtual API . projects . locations

Instance Methods

bareMetalAdminClusters() diff --git a/docs/dyn/gkeonprem_v1.projects.locations.operations.html b/docs/dyn/gkeonprem_v1.projects.locations.operations.html index f717d4245ae..907deb4634e 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.operations.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.operations.html @@ -72,7 +72,7 @@ -

Anthos On-Prem API . projects . locations . operations

+

GDC Virtual API . projects . locations . operations

Instance Methods

cancel(name, body=None, x__xgafv=None)

diff --git a/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.html b/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.html index 469e72b2a8e..c8d4dc6d152 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.html @@ -72,7 +72,7 @@ -

Anthos On-Prem API . projects . locations . vmwareAdminClusters

+

GDC Virtual API . projects . locations . vmwareAdminClusters

Instance Methods

operations() @@ -86,13 +86,13 @@

Instance Methods

enroll(parent, body=None, x__xgafv=None)

Enrolls an existing VMware admin cluster to the Anthos On-Prem API within a given project and location. Through enrollment, an existing admin cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster will be expected to be performed through the API.

- get(name, view=None, x__xgafv=None)

+ get(name, allowMissing=None, view=None, x__xgafv=None)

Gets details of a single VMware admin cluster.

getIamPolicy(resource, options_requestedPolicyVersion=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.

- list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)

+ list(parent, allowMissing=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)

Lists VMware admin clusters in a given project and location.

list_next()

@@ -159,11 +159,12 @@

Method Details

- get(name, view=None, x__xgafv=None) + get(name, allowMissing=None, view=None, x__xgafv=None)
Gets details of a single VMware admin cluster.
 
 Args:
   name: string, Required. Name of the VMware admin cluster to be returned. Format: "projects/{project}/locations/{location}/vmwareAdminClusters/{vmware_admin_cluster}" (required)
+  allowMissing: boolean, Optional. If true, return Vmware Admin Cluster including the one that only exists in RMS.
   view: string, View for VMware admin cluster. When `BASIC` is specified, only the cluster resource name and membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete cluster configuration details.
     Allowed values
       CLUSTER_VIEW_UNSPECIFIED - If the value is not set, the default `FULL` view is used.
@@ -320,6 +321,15 @@ 

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "version": "A String", # The version of the bundle. }, @@ -337,6 +347,15 @@

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, }, "preparedSecrets": { # VmwareAdminPreparedSecretsConfig represents configuration for admin cluster prepared secrets. # Output only. The VMware admin cluster prepared secrets configuration. It should always be enabled by the Central API, instead of letting users set it. @@ -355,9 +374,33 @@

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "uid": "A String", # Output only. The unique identifier of the VMware admin cluster. "updateTime": "A String", # Output only. The time at which VMware admin cluster was last updated. + "validationCheck": { # ValidationCheck represents the result of preflight check. # Output only. ValidationCheck represents the result of the preflight check job. + "option": "A String", # Options used for the validation check + "scenario": "A String", # Output only. The scenario when the preflight checks were run. + "status": { # ValidationCheckStatus defines the detailed validation check status. # Output only. The detailed validation check status. + "result": [ # Individual checks which failed as part of the Preflight check execution. + { # ValidationCheckResult defines the details about the validation check. + "category": "A String", # The category of the validation. + "description": "A String", # The description of the validation check. + "details": "A String", # Detailed failure information, which might be unformatted. + "reason": "A String", # A human-readable message of the check failure. + "state": "A String", # The validation check state. + }, + ], + }, + }, "vcenter": { # VmwareAdminVCenterConfig contains VCenter configuration for VMware admin cluster. # The VMware admin cluster VCenter configuration. "address": "A String", # The vCenter IP address. "caCertData": "A String", # Contains the vCenter CA certificate public key for SSL verification. @@ -408,11 +451,12 @@

Method Details

- list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None) + list(parent, allowMissing=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists VMware admin clusters in a given project and location.
 
 Args:
   parent: string, Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}" (required)
+  allowMissing: boolean, Optional. If true, return list of Vmware Admin Clusters including the ones that only exists in RMS.
   pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A token identifying a page of results the server should return.
   view: string, View for VMware admin clusters. When `BASIC` is specified, only the admin cluster resource name and membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete admin cluster configuration details.
@@ -577,6 +621,15 @@ 

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "version": "A String", # The version of the bundle. }, @@ -594,6 +647,15 @@

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, }, "preparedSecrets": { # VmwareAdminPreparedSecretsConfig represents configuration for admin cluster prepared secrets. # Output only. The VMware admin cluster prepared secrets configuration. It should always be enabled by the Central API, instead of letting users set it. @@ -612,9 +674,33 @@

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "uid": "A String", # Output only. The unique identifier of the VMware admin cluster. "updateTime": "A String", # Output only. The time at which VMware admin cluster was last updated. + "validationCheck": { # ValidationCheck represents the result of preflight check. # Output only. ValidationCheck represents the result of the preflight check job. + "option": "A String", # Options used for the validation check + "scenario": "A String", # Output only. The scenario when the preflight checks were run. + "status": { # ValidationCheckStatus defines the detailed validation check status. # Output only. The detailed validation check status. + "result": [ # Individual checks which failed as part of the Preflight check execution. + { # ValidationCheckResult defines the details about the validation check. + "category": "A String", # The category of the validation. + "description": "A String", # The description of the validation check. + "details": "A String", # Detailed failure information, which might be unformatted. + "reason": "A String", # A human-readable message of the check failure. + "state": "A String", # The validation check state. + }, + ], + }, + }, "vcenter": { # VmwareAdminVCenterConfig contains VCenter configuration for VMware admin cluster. # The VMware admin cluster VCenter configuration. "address": "A String", # The vCenter IP address. "caCertData": "A String", # Contains the vCenter CA certificate public key for SSL verification. @@ -797,6 +883,15 @@

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "version": "A String", # The version of the bundle. }, @@ -814,6 +909,15 @@

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, }, "preparedSecrets": { # VmwareAdminPreparedSecretsConfig represents configuration for admin cluster prepared secrets. # Output only. The VMware admin cluster prepared secrets configuration. It should always be enabled by the Central API, instead of letting users set it. @@ -832,9 +936,33 @@

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "uid": "A String", # Output only. The unique identifier of the VMware admin cluster. "updateTime": "A String", # Output only. The time at which VMware admin cluster was last updated. + "validationCheck": { # ValidationCheck represents the result of preflight check. # Output only. ValidationCheck represents the result of the preflight check job. + "option": "A String", # Options used for the validation check + "scenario": "A String", # Output only. The scenario when the preflight checks were run. + "status": { # ValidationCheckStatus defines the detailed validation check status. # Output only. The detailed validation check status. + "result": [ # Individual checks which failed as part of the Preflight check execution. + { # ValidationCheckResult defines the details about the validation check. + "category": "A String", # The category of the validation. + "description": "A String", # The description of the validation check. + "details": "A String", # Detailed failure information, which might be unformatted. + "reason": "A String", # A human-readable message of the check failure. + "state": "A String", # The validation check state. + }, + ], + }, + }, "vcenter": { # VmwareAdminVCenterConfig contains VCenter configuration for VMware admin cluster. # The VMware admin cluster VCenter configuration. "address": "A String", # The vCenter IP address. "caCertData": "A String", # Contains the vCenter CA certificate public key for SSL verification. diff --git a/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.operations.html b/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.operations.html index 6b1b66dc3d1..06047d48919 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.operations.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.operations.html @@ -72,7 +72,7 @@ -

Anthos On-Prem API . projects . locations . vmwareAdminClusters . operations

+

GDC Virtual API . projects . locations . vmwareAdminClusters . operations

Instance Methods

close()

diff --git a/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.html b/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.html index e60df75616d..d932941a3ec 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.html @@ -72,7 +72,7 @@ -

Anthos On-Prem API . projects . locations . vmwareClusters

+

GDC Virtual API . projects . locations . vmwareClusters

Instance Methods

operations() @@ -88,7 +88,7 @@

Instance Methods

close()

Close httplib2 connections.

- create(parent, body, validateOnly=None, vmwareClusterId=None, x__xgafv=None)

+ create(parent, body, allowPreflightFailure=None, validateOnly=None, vmwareClusterId=None, x__xgafv=None)

Creates a new VMware user cluster in a given project and location.

delete(name, allowMissing=None, etag=None, force=None, ignoreErrors=None, validateOnly=None, x__xgafv=None)

@@ -97,13 +97,13 @@

Instance Methods

enroll(parent, body=None, x__xgafv=None)

Enrolls an existing VMware user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API.

- get(name, view=None, x__xgafv=None)

+ get(name, allowMissing=None, view=None, x__xgafv=None)

Gets details of a single VMware Cluster.

getIamPolicy(resource, options_requestedPolicyVersion=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.

- list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)

+ list(parent, allowMissing=None, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)

Lists VMware Clusters in a given project and location.

list_next()

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

Method Details

- create(parent, body, validateOnly=None, vmwareClusterId=None, x__xgafv=None) + create(parent, body, allowPreflightFailure=None, validateOnly=None, vmwareClusterId=None, x__xgafv=None)
Creates a new VMware user cluster in a given project and location.
 
 Args:
@@ -303,6 +303,15 @@ 

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "storage": { # Specifies vSphere CSI components deployment config in the VMware user cluster. # Storage configuration. "vsphereCsiDisabled": True or False, # Whether or not to deploy vSphere CSI components in the VMware user cluster. Enabled by default. @@ -340,6 +349,7 @@

Method Details

"vmTrackingEnabled": True or False, # Enable VM tracking. } + allowPreflightFailure: boolean, Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with "cluster already exists" error and hence a update cluster is required to fix the cluster. validateOnly: boolean, Validate the request without actually doing any updates. vmwareClusterId: string, User provided identifier that is used as part of the resource name; This value must be up to 40 characters and follow RFC-1123 (https://tools.ietf.org/html/rfc1123) format. x__xgafv: string, V1 error format. @@ -457,11 +467,12 @@

Method Details

- get(name, view=None, x__xgafv=None) + get(name, allowMissing=None, view=None, x__xgafv=None)
Gets details of a single VMware Cluster.
 
 Args:
   name: string, Required. Name of the VMware user cluster to be returned. Format: "projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}" (required)
+  allowMissing: boolean, Optional. If true, return Vmware Cluster including the one that only exists in RMS.
   view: string, View for VMware user cluster. When `BASIC` is specified, only the cluster resource name and admin cluster membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete cluster configuration details.
     Allowed values
       CLUSTER_VIEW_UNSPECIFIED - If the value is not set, the default `FULL` view is used.
@@ -640,6 +651,15 @@ 

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "storage": { # Specifies vSphere CSI components deployment config in the VMware user cluster. # Storage configuration. "vsphereCsiDisabled": True or False, # Whether or not to deploy vSphere CSI components in the VMware user cluster. Enabled by default. @@ -714,11 +734,12 @@

Method Details

- list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None) + list(parent, allowMissing=None, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists VMware Clusters in a given project and location.
 
 Args:
   parent: string, Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}" (required)
+  allowMissing: boolean, Optional. If true, return list of Vmware Clusters including the ones that only exists in RMS.
   filter: string, A resource filtering expression following https://google.aip.dev/160. When non-empty, only resource's whose attributes field matches the filter are returned.
   pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A token identifying a page of results the server should return.
@@ -906,6 +927,15 @@ 

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "storage": { # Specifies vSphere CSI components deployment config in the VMware user cluster. # Storage configuration. "vsphereCsiDisabled": True or False, # Whether or not to deploy vSphere CSI components in the VMware user cluster. Enabled by default. @@ -1134,6 +1164,15 @@

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "storage": { # Specifies vSphere CSI components deployment config in the VMware user cluster. # Storage configuration. "vsphereCsiDisabled": True or False, # Whether or not to deploy vSphere CSI components in the VMware user cluster. Enabled by default. diff --git a/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.operations.html b/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.operations.html index 8b32376f118..a3cbbd313c0 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.operations.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.operations.html @@ -72,7 +72,7 @@ -

Anthos On-Prem API . projects . locations . vmwareClusters . operations

+

GDC Virtual API . projects . locations . vmwareClusters . operations

Instance Methods

close()

diff --git a/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.vmwareNodePools.html b/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.vmwareNodePools.html index 55808160c98..63a380e64c4 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.vmwareNodePools.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.vmwareNodePools.html @@ -72,7 +72,7 @@ -

Anthos On-Prem API . projects . locations . vmwareClusters . vmwareNodePools

+

GDC Virtual API . projects . locations . vmwareClusters . vmwareNodePools

Instance Methods

operations() @@ -188,6 +188,15 @@

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "uid": "A String", # Output only. The unique identifier of the node pool. "updateTime": "A String", # Output only. The time at which this node pool was last updated. @@ -382,6 +391,15 @@

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "uid": "A String", # Output only. The unique identifier of the node pool. "updateTime": "A String", # Output only. The time at which this node pool was last updated. @@ -508,6 +526,15 @@

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "uid": "A String", # Output only. The unique identifier of the node pool. "updateTime": "A String", # Output only. The time at which this node pool was last updated. @@ -597,6 +624,15 @@

Method Details

}, ], "errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention. + "version": "A String", # Reflect current version of the resource. + "versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version. + "versions": [ # Shows the mapping of a given version to the number of machines under this version. + { # Version describes the number of nodes at a given version under a resource. + "count": "A String", # Number of machines under the above version. + "version": "A String", # Resource version. + }, + ], + }, }, "uid": "A String", # Output only. The unique identifier of the node pool. "updateTime": "A String", # Output only. The time at which this node pool was last updated. diff --git a/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.vmwareNodePools.operations.html b/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.vmwareNodePools.operations.html index 98df90ad121..5204937cb7f 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.vmwareNodePools.operations.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.vmwareNodePools.operations.html @@ -72,7 +72,7 @@ -

Anthos On-Prem API . projects . locations . vmwareClusters . vmwareNodePools . operations

+

GDC Virtual API . projects . locations . vmwareClusters . vmwareNodePools . operations

Instance Methods

close()

diff --git a/docs/dyn/looker_v1.projects.locations.instances.html b/docs/dyn/looker_v1.projects.locations.instances.html index 3b11c1c82e5..b98eea85ad7 100644 --- a/docs/dyn/looker_v1.projects.locations.instances.html +++ b/docs/dyn/looker_v1.projects.locations.instances.html @@ -212,6 +212,20 @@

Method Details

}, "platformEdition": "A String", # Platform edition. "privateIpEnabled": True or False, # Whether private IP is enabled on the Looker instance. + "pscConfig": { # Information for Private Service Connect (PSC) setup for a Looker instance. # Optional. PSC configuration. Used when `psc_enabled` is true. + "allowedVpcs": [ # Optional. List of VPCs that are allowed ingress into looker. Format: projects/{project}/global/networks/{network} + "A String", + ], + "lookerServiceAttachmentUri": "A String", # Output only. URI of the Looker service attachment. + "serviceAttachments": [ # Optional. List of egress service attachment configurations. + { # Service attachment configuration. + "connectionStatus": "A String", # Output only. Connection status. + "localFqdn": "A String", # Required. Fully qualified domain name that will be used in the private DNS record created for the service attachment. + "targetServiceAttachmentUri": "A String", # Required. URI of the service attachment to connect to. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment} + }, + ], + }, + "pscEnabled": True or False, # Optional. Whether to use Private Service Connect (PSC) for private IP connectivity. If true, neither `public_ip_enabled` nor `private_ip_enabled` can be true. "publicIpEnabled": True or False, # Whether public IP is enabled on the Looker instance. "reservedRange": "A String", # Name of a reserved IP address range within the Instance.consumer_network, to be used for private services access connection. May or may not be specified in a create request. "state": "A String", # Output only. The state of the instance. @@ -427,6 +441,20 @@

Method Details

}, "platformEdition": "A String", # Platform edition. "privateIpEnabled": True or False, # Whether private IP is enabled on the Looker instance. + "pscConfig": { # Information for Private Service Connect (PSC) setup for a Looker instance. # Optional. PSC configuration. Used when `psc_enabled` is true. + "allowedVpcs": [ # Optional. List of VPCs that are allowed ingress into looker. Format: projects/{project}/global/networks/{network} + "A String", + ], + "lookerServiceAttachmentUri": "A String", # Output only. URI of the Looker service attachment. + "serviceAttachments": [ # Optional. List of egress service attachment configurations. + { # Service attachment configuration. + "connectionStatus": "A String", # Output only. Connection status. + "localFqdn": "A String", # Required. Fully qualified domain name that will be used in the private DNS record created for the service attachment. + "targetServiceAttachmentUri": "A String", # Required. URI of the service attachment to connect to. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment} + }, + ], + }, + "pscEnabled": True or False, # Optional. Whether to use Private Service Connect (PSC) for private IP connectivity. If true, neither `public_ip_enabled` nor `private_ip_enabled` can be true. "publicIpEnabled": True or False, # Whether public IP is enabled on the Looker instance. "reservedRange": "A String", # Name of a reserved IP address range within the Instance.consumer_network, to be used for private services access connection. May or may not be specified in a create request. "state": "A String", # Output only. The state of the instance. @@ -626,6 +654,20 @@

Method Details

}, "platformEdition": "A String", # Platform edition. "privateIpEnabled": True or False, # Whether private IP is enabled on the Looker instance. + "pscConfig": { # Information for Private Service Connect (PSC) setup for a Looker instance. # Optional. PSC configuration. Used when `psc_enabled` is true. + "allowedVpcs": [ # Optional. List of VPCs that are allowed ingress into looker. Format: projects/{project}/global/networks/{network} + "A String", + ], + "lookerServiceAttachmentUri": "A String", # Output only. URI of the Looker service attachment. + "serviceAttachments": [ # Optional. List of egress service attachment configurations. + { # Service attachment configuration. + "connectionStatus": "A String", # Output only. Connection status. + "localFqdn": "A String", # Required. Fully qualified domain name that will be used in the private DNS record created for the service attachment. + "targetServiceAttachmentUri": "A String", # Required. URI of the service attachment to connect to. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment} + }, + ], + }, + "pscEnabled": True or False, # Optional. Whether to use Private Service Connect (PSC) for private IP connectivity. If true, neither `public_ip_enabled` nor `private_ip_enabled` can be true. "publicIpEnabled": True or False, # Whether public IP is enabled on the Looker instance. "reservedRange": "A String", # Name of a reserved IP address range within the Instance.consumer_network, to be used for private services access connection. May or may not be specified in a create request. "state": "A String", # Output only. The state of the instance. @@ -746,6 +788,20 @@

Method Details

}, "platformEdition": "A String", # Platform edition. "privateIpEnabled": True or False, # Whether private IP is enabled on the Looker instance. + "pscConfig": { # Information for Private Service Connect (PSC) setup for a Looker instance. # Optional. PSC configuration. Used when `psc_enabled` is true. + "allowedVpcs": [ # Optional. List of VPCs that are allowed ingress into looker. Format: projects/{project}/global/networks/{network} + "A String", + ], + "lookerServiceAttachmentUri": "A String", # Output only. URI of the Looker service attachment. + "serviceAttachments": [ # Optional. List of egress service attachment configurations. + { # Service attachment configuration. + "connectionStatus": "A String", # Output only. Connection status. + "localFqdn": "A String", # Required. Fully qualified domain name that will be used in the private DNS record created for the service attachment. + "targetServiceAttachmentUri": "A String", # Required. URI of the service attachment to connect to. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment} + }, + ], + }, + "pscEnabled": True or False, # Optional. Whether to use Private Service Connect (PSC) for private IP connectivity. If true, neither `public_ip_enabled` nor `private_ip_enabled` can be true. "publicIpEnabled": True or False, # Whether public IP is enabled on the Looker instance. "reservedRange": "A String", # Name of a reserved IP address range within the Instance.consumer_network, to be used for private services access connection. May or may not be specified in a create request. "state": "A String", # Output only. The state of the instance. diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.businessInfo.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.businessInfo.html index 3e031b011e9..beb72d5de51 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.businessInfo.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.businessInfo.html @@ -133,6 +133,7 @@

Method Details

}, "uri": "A String", # Optional. The URI where customer service may be found. }, + "koreanBusinessRegistrationNumber": "A String", # Optional. The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. "name": "A String", # Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo` "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Output only. The phone number of the business. "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes @@ -185,6 +186,7 @@

Method Details

}, "uri": "A String", # Optional. The URI where customer service may be found. }, + "koreanBusinessRegistrationNumber": "A String", # Optional. The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. "name": "A String", # Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo` "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Output only. The phone number of the business. "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes @@ -236,6 +238,7 @@

Method Details

}, "uri": "A String", # Optional. The URI where customer service may be found. }, + "koreanBusinessRegistrationNumber": "A String", # Optional. The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. "name": "A String", # Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo` "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Output only. The phone number of the business. "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html index 68e608188bd..68fd7e9a661 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html @@ -183,6 +183,12 @@

Method Details

{ # A request to delete a list of asset. "allowMissing": True or False, # Optional. When this value is set to `true` the request is a no-op for non-existing assets. See https://google.aip.dev/135#delete-if-existing for additional details. Default value is `false`. + "cascadingRules": [ # Optional. Optional cascading rules for deleting related assets. + { # Specifies cascading rules for traversing relations. + "cascadeLogicalDbs": { # Cascading rule for related logical DBs. # Cascading rule for related logical DBs. + }, + }, + ], "names": [ # Required. The IDs of the assets to delete. A maximum of 1000 assets can be deleted in a batch. Format: projects/{project}/locations/{location}/assets/{name}. "A String", ], diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.html index fac4a405dff..3037f0de281 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.html @@ -109,6 +109,11 @@

Instance Methods

Returns the preferenceSets Resource.

+

+ relations() +

+

Returns the relations Resource.

+

reportConfigs()

diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.relations.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.relations.html new file mode 100644 index 00000000000..f17eb10ea97 --- /dev/null +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.relations.html @@ -0,0 +1,164 @@ + + + +

Migration Center API . projects . locations . relations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets the details of an relation.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists all the relations in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets the details of an relation.
+
+Args:
+  name: string, Required. Name of the resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message representing a relation between 2 resource.
+  "createTime": "A String", # Output only. The timestamp when the relation was created.
+  "dstAsset": "A String", # Output only. The destination asset name in the relation.
+  "name": "A String", # Output only. Identifier. The identifier of the relation.
+  "srcAsset": "A String", # Output only. The source asset name in the relation.
+  "type": "A String", # Optional. The type of the relation.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all the relations in a given project and location.
+
+Args:
+  parent: string, Required. Parent value for `ListRelationsRequest`. (required)
+  filter: string, Filtering results.
+  orderBy: string, Field to sort by. See https://google.aip.dev/132#ordering for more details.
+  pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
+  pageToken: string, A token identifying a page of results the server should return.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for listing relations.
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "relations": [ # A list of relations.
+    { # Message representing a relation between 2 resource.
+      "createTime": "A String", # Output only. The timestamp when the relation was created.
+      "dstAsset": "A String", # Output only. The destination asset name in the relation.
+      "name": "A String", # Output only. Identifier. The identifier of the relation.
+      "srcAsset": "A String", # Output only. The source asset name in the relation.
+      "type": "A String", # Optional. The type of the relation.
+    },
+  ],
+}
+
+ +
+ list_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.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html index e0ae868800c..cf37d593679 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html @@ -148,6 +148,8 @@

Method Details

"networkType": "A String", # Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source. "port": 42, # The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP. "projectId": "A String", # Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a Google Cloud project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project. + "redisCluster": "A String", # A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) URI. + "redisInstance": "A String", # A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) URI. }, "displayName": "A String", # Output only. The display name of a Connectivity Test. "labels": { # Resource labels to represent user-provided metadata. @@ -490,6 +492,8 @@

Method Details

"networkType": "A String", # Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source. "port": 42, # The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP. "projectId": "A String", # Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a Google Cloud project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project. + "redisCluster": "A String", # A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) URI. + "redisInstance": "A String", # A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) URI. }, "updateTime": "A String", # Output only. The time the test's configuration was updated. } @@ -599,6 +603,8 @@

Method Details

"networkType": "A String", # Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source. "port": 42, # The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP. "projectId": "A String", # Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a Google Cloud project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project. + "redisCluster": "A String", # A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) URI. + "redisInstance": "A String", # A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) URI. }, "displayName": "A String", # Output only. The display name of a Connectivity Test. "labels": { # Resource labels to represent user-provided metadata. @@ -941,6 +947,8 @@

Method Details

"networkType": "A String", # Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source. "port": 42, # The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP. "projectId": "A String", # Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a Google Cloud project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project. + "redisCluster": "A String", # A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) URI. + "redisInstance": "A String", # A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) URI. }, "updateTime": "A String", # Output only. The time the test's configuration was updated. }
@@ -1041,6 +1049,8 @@

Method Details

"networkType": "A String", # Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source. "port": 42, # The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP. "projectId": "A String", # Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a Google Cloud project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project. + "redisCluster": "A String", # A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) URI. + "redisInstance": "A String", # A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) URI. }, "displayName": "A String", # Output only. The display name of a Connectivity Test. "labels": { # Resource labels to represent user-provided metadata. @@ -1383,6 +1393,8 @@

Method Details

"networkType": "A String", # Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source. "port": 42, # The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP. "projectId": "A String", # Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a Google Cloud project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project. + "redisCluster": "A String", # A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) URI. + "redisInstance": "A String", # A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) URI. }, "updateTime": "A String", # Output only. The time the test's configuration was updated. }, @@ -1442,6 +1454,8 @@

Method Details

"networkType": "A String", # Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source. "port": 42, # The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP. "projectId": "A String", # Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a Google Cloud project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project. + "redisCluster": "A String", # A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) URI. + "redisInstance": "A String", # A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) URI. }, "displayName": "A String", # Output only. The display name of a Connectivity Test. "labels": { # Resource labels to represent user-provided metadata. @@ -1784,6 +1798,8 @@

Method Details

"networkType": "A String", # Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source. "port": 42, # The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP. "projectId": "A String", # Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a Google Cloud project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project. + "redisCluster": "A String", # A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) URI. + "redisInstance": "A String", # A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) URI. }, "updateTime": "A String", # Output only. The time the test's configuration was updated. } diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.vpcFlowLogsConfigs.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.vpcFlowLogsConfigs.html index a92c9e72dd6..8a20f8f6f5b 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 considrered 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. The following fields are not considrered 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

+

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

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 considrered 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)
@@ -293,7 +293,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. The following fields are not considrered 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
+  
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 
 
 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/networkservices_v1.projects.locations.gateways.html b/docs/dyn/networkservices_v1.projects.locations.gateways.html
index 2038a86ece3..055e5d00ba1 100644
--- a/docs/dyn/networkservices_v1.projects.locations.gateways.html
+++ b/docs/dyn/networkservices_v1.projects.locations.gateways.html
@@ -130,6 +130,7 @@ 

Method Details

"ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. 42, ], + "routingMode": "A String", # Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY. "scope": "A String", # Optional. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens. "selfLink": "A String", # Output only. Server-defined URL of this resource "serverTlsPolicy": "A String", # Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled. @@ -237,6 +238,7 @@

Method Details

"ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. 42, ], + "routingMode": "A String", # Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY. "scope": "A String", # Optional. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens. "selfLink": "A String", # Output only. Server-defined URL of this resource "serverTlsPolicy": "A String", # Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled. @@ -284,6 +286,7 @@

Method Details

"ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. 42, ], + "routingMode": "A String", # Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY. "scope": "A String", # Optional. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens. "selfLink": "A String", # Output only. Server-defined URL of this resource "serverTlsPolicy": "A String", # Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled. @@ -342,6 +345,7 @@

Method Details

"ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. 42, ], + "routingMode": "A String", # Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY. "scope": "A String", # Optional. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens. "selfLink": "A String", # Output only. Server-defined URL of this resource "serverTlsPolicy": "A String", # Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled. diff --git a/docs/dyn/networkservices_v1.projects.locations.grpcRoutes.html b/docs/dyn/networkservices_v1.projects.locations.grpcRoutes.html index 718048724d8..49a1c289088 100644 --- a/docs/dyn/networkservices_v1.projects.locations.grpcRoutes.html +++ b/docs/dyn/networkservices_v1.projects.locations.grpcRoutes.html @@ -146,7 +146,7 @@

Method Details

}, }, "idleTimeout": "A String", # Optional. Specifies the idle timeout for the selected route. The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set to 0s, the timeout will be disabled. - "retryPolicy": { # The specifications for retries. # Optional. Specifies the retry policy associated with this route. + "retryPolicy": { # The specifications for retries. Specifies one or more conditions for which this retry rule applies. Valid values are: # Optional. Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number of retries. This number must be > 0. If not specified, default to 1. "retryConditions": [ # - connect-failure: Router will retry on failures connecting to Backend Services, for example due to connection timeouts. - refused-stream: Router will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelled: Router will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Router will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Router will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Router will retry if the gRPC status code in the response header is set to unavailable "A String", @@ -295,7 +295,7 @@

Method Details

}, }, "idleTimeout": "A String", # Optional. Specifies the idle timeout for the selected route. The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set to 0s, the timeout will be disabled. - "retryPolicy": { # The specifications for retries. # Optional. Specifies the retry policy associated with this route. + "retryPolicy": { # The specifications for retries. Specifies one or more conditions for which this retry rule applies. Valid values are: # Optional. Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number of retries. This number must be > 0. If not specified, default to 1. "retryConditions": [ # - connect-failure: Router will retry on failures connecting to Backend Services, for example due to connection timeouts. - refused-stream: Router will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelled: Router will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Router will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Router will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Router will retry if the gRPC status code in the response header is set to unavailable "A String", @@ -384,7 +384,7 @@

Method Details

}, }, "idleTimeout": "A String", # Optional. Specifies the idle timeout for the selected route. The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set to 0s, the timeout will be disabled. - "retryPolicy": { # The specifications for retries. # Optional. Specifies the retry policy associated with this route. + "retryPolicy": { # The specifications for retries. Specifies one or more conditions for which this retry rule applies. Valid values are: # Optional. Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number of retries. This number must be > 0. If not specified, default to 1. "retryConditions": [ # - connect-failure: Router will retry on failures connecting to Backend Services, for example due to connection timeouts. - refused-stream: Router will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelled: Router will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Router will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Router will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Router will retry if the gRPC status code in the response header is set to unavailable "A String", @@ -481,7 +481,7 @@

Method Details

}, }, "idleTimeout": "A String", # Optional. Specifies the idle timeout for the selected route. The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set to 0s, the timeout will be disabled. - "retryPolicy": { # The specifications for retries. # Optional. Specifies the retry policy associated with this route. + "retryPolicy": { # The specifications for retries. Specifies one or more conditions for which this retry rule applies. Valid values are: # Optional. Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number of retries. This number must be > 0. If not specified, default to 1. "retryConditions": [ # - connect-failure: Router will retry on failures connecting to Backend Services, for example due to connection timeouts. - refused-stream: Router will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelled: Router will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Router will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Router will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Router will retry if the gRPC status code in the response header is set to unavailable "A String", diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.gateways.html b/docs/dyn/networkservices_v1beta1.projects.locations.gateways.html index 56156468ded..88432a78fdb 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.gateways.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.gateways.html @@ -130,6 +130,7 @@

Method Details

"ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. 42, ], + "routingMode": "A String", # Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY. "scope": "A String", # Optional. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens. "selfLink": "A String", # Output only. Server-defined URL of this resource "serverTlsPolicy": "A String", # Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled. @@ -237,6 +238,7 @@

Method Details

"ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. 42, ], + "routingMode": "A String", # Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY. "scope": "A String", # Optional. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens. "selfLink": "A String", # Output only. Server-defined URL of this resource "serverTlsPolicy": "A String", # Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled. @@ -284,6 +286,7 @@

Method Details

"ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. 42, ], + "routingMode": "A String", # Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY. "scope": "A String", # Optional. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens. "selfLink": "A String", # Output only. Server-defined URL of this resource "serverTlsPolicy": "A String", # Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled. @@ -342,6 +345,7 @@

Method Details

"ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. 42, ], + "routingMode": "A String", # Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY. "scope": "A String", # Optional. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens. "selfLink": "A String", # Output only. Server-defined URL of this resource "serverTlsPolicy": "A String", # Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled. diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.grpcRoutes.html b/docs/dyn/networkservices_v1beta1.projects.locations.grpcRoutes.html index 7dfda773387..166e6debc3b 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.grpcRoutes.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.grpcRoutes.html @@ -146,7 +146,7 @@

Method Details

}, }, "idleTimeout": "A String", # Optional. Specifies the idle timeout for the selected route. The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set to 0s, the timeout will be disabled. - "retryPolicy": { # The specifications for retries. # Optional. Specifies the retry policy associated with this route. + "retryPolicy": { # The specifications for retries. Specifies one or more conditions for which this retry rule applies. Valid values are: # Optional. Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number of retries. This number must be > 0. If not specified, default to 1. "retryConditions": [ # - connect-failure: Router will retry on failures connecting to Backend Services, for example due to connection timeouts. - refused-stream: Router will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelled: Router will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Router will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Router will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Router will retry if the gRPC status code in the response header is set to unavailable "A String", @@ -295,7 +295,7 @@

Method Details

}, }, "idleTimeout": "A String", # Optional. Specifies the idle timeout for the selected route. The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set to 0s, the timeout will be disabled. - "retryPolicy": { # The specifications for retries. # Optional. Specifies the retry policy associated with this route. + "retryPolicy": { # The specifications for retries. Specifies one or more conditions for which this retry rule applies. Valid values are: # Optional. Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number of retries. This number must be > 0. If not specified, default to 1. "retryConditions": [ # - connect-failure: Router will retry on failures connecting to Backend Services, for example due to connection timeouts. - refused-stream: Router will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelled: Router will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Router will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Router will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Router will retry if the gRPC status code in the response header is set to unavailable "A String", @@ -384,7 +384,7 @@

Method Details

}, }, "idleTimeout": "A String", # Optional. Specifies the idle timeout for the selected route. The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set to 0s, the timeout will be disabled. - "retryPolicy": { # The specifications for retries. # Optional. Specifies the retry policy associated with this route. + "retryPolicy": { # The specifications for retries. Specifies one or more conditions for which this retry rule applies. Valid values are: # Optional. Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number of retries. This number must be > 0. If not specified, default to 1. "retryConditions": [ # - connect-failure: Router will retry on failures connecting to Backend Services, for example due to connection timeouts. - refused-stream: Router will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelled: Router will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Router will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Router will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Router will retry if the gRPC status code in the response header is set to unavailable "A String", @@ -481,7 +481,7 @@

Method Details

}, }, "idleTimeout": "A String", # Optional. Specifies the idle timeout for the selected route. The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set to 0s, the timeout will be disabled. - "retryPolicy": { # The specifications for retries. # Optional. Specifies the retry policy associated with this route. + "retryPolicy": { # The specifications for retries. Specifies one or more conditions for which this retry rule applies. Valid values are: # Optional. Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number of retries. This number must be > 0. If not specified, default to 1. "retryConditions": [ # - connect-failure: Router will retry on failures connecting to Backend Services, for example due to connection timeouts. - refused-stream: Router will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelled: Router will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Router will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Router will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Router will retry if the gRPC status code in the response header is set to unavailable "A String", diff --git a/docs/dyn/notebooks_v2.projects.locations.instances.html b/docs/dyn/notebooks_v2.projects.locations.instances.html index 47b44cf7bf0..f172fb3e946 100644 --- a/docs/dyn/notebooks_v2.projects.locations.instances.html +++ b/docs/dyn/notebooks_v2.projects.locations.instances.html @@ -116,6 +116,9 @@

Instance Methods

resizeDisk(notebookInstance, body=None, x__xgafv=None)

Resize a notebook instance disk to a higher capacity.

+

+ restore(name, body=None, x__xgafv=None)

+

RestoreInstance restores an Instance from a BackupSource.

rollback(name, body=None, x__xgafv=None)

Rollbacks a notebook instance to the previous version.

@@ -1027,6 +1030,51 @@

Method Details

}
+
+ restore(name, body=None, x__xgafv=None) +
RestoreInstance restores an Instance from a BackupSource.
+
+Args:
+  name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for restoring the notebook instance from a BackupSource.
+  "snapshot": { # Snapshot represents the snapshot of the data disk used to restore the Workbench Instance from. Refers to: compute/v1/projects/{project_id}/global/snapshots/{snapshot_id} # Snapshot to be used for restore.
+    "projectId": "A String", # Required. The project ID of the snapshot.
+    "snapshotId": "A String", # Required. The ID of the snapshot.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
rollback(name, body=None, x__xgafv=None)
Rollbacks a notebook instance to the previous version.
diff --git a/docs/dyn/privateca_v1.projects.locations.caPools.certificateAuthorities.html b/docs/dyn/privateca_v1.projects.locations.caPools.certificateAuthorities.html
index fa7ac92d605..b1a44df1225 100644
--- a/docs/dyn/privateca_v1.projects.locations.caPools.certificateAuthorities.html
+++ b/docs/dyn/privateca_v1.projects.locations.caPools.certificateAuthorities.html
@@ -250,6 +250,7 @@ 

Method Details

"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2. "keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key. }, + "tbsCertificateDigest": "A String", # The hash of the pre-signed certificate, which will be signed by the CA. Corresponds to the TBS Certificate in https://tools.ietf.org/html/rfc5280#section-4.1.2. The field will always be populated. "x509Description": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Describes some of the technical X.509 fields in a certificate. "additionalExtensions": [ # Optional. Describes custom X.509 extensions. { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. @@ -751,6 +752,7 @@

Method Details

"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2. "keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key. }, + "tbsCertificateDigest": "A String", # The hash of the pre-signed certificate, which will be signed by the CA. Corresponds to the TBS Certificate in https://tools.ietf.org/html/rfc5280#section-4.1.2. The field will always be populated. "x509Description": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Describes some of the technical X.509 fields in a certificate. "additionalExtensions": [ # Optional. Describes custom X.509 extensions. { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. @@ -1085,6 +1087,7 @@

Method Details

"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2. "keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key. }, + "tbsCertificateDigest": "A String", # The hash of the pre-signed certificate, which will be signed by the CA. Corresponds to the TBS Certificate in https://tools.ietf.org/html/rfc5280#section-4.1.2. The field will always be populated. "x509Description": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Describes some of the technical X.509 fields in a certificate. "additionalExtensions": [ # Optional. Describes custom X.509 extensions. { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. @@ -1428,6 +1431,7 @@

Method Details

"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2. "keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key. }, + "tbsCertificateDigest": "A String", # The hash of the pre-signed certificate, which will be signed by the CA. Corresponds to the TBS Certificate in https://tools.ietf.org/html/rfc5280#section-4.1.2. The field will always be populated. "x509Description": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Describes some of the technical X.509 fields in a certificate. "additionalExtensions": [ # Optional. Describes custom X.509 extensions. { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. diff --git a/docs/dyn/privateca_v1.projects.locations.caPools.certificates.html b/docs/dyn/privateca_v1.projects.locations.caPools.certificates.html index 185262d88c5..c1a559567dc 100644 --- a/docs/dyn/privateca_v1.projects.locations.caPools.certificates.html +++ b/docs/dyn/privateca_v1.projects.locations.caPools.certificates.html @@ -172,6 +172,7 @@

Method Details

"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2. "keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key. }, + "tbsCertificateDigest": "A String", # The hash of the pre-signed certificate, which will be signed by the CA. Corresponds to the TBS Certificate in https://tools.ietf.org/html/rfc5280#section-4.1.2. The field will always be populated. "x509Description": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Describes some of the technical X.509 fields in a certificate. "additionalExtensions": [ # Optional. Describes custom X.509 extensions. { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. @@ -478,6 +479,7 @@

Method Details

"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2. "keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key. }, + "tbsCertificateDigest": "A String", # The hash of the pre-signed certificate, which will be signed by the CA. Corresponds to the TBS Certificate in https://tools.ietf.org/html/rfc5280#section-4.1.2. The field will always be populated. "x509Description": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Describes some of the technical X.509 fields in a certificate. "additionalExtensions": [ # Optional. Describes custom X.509 extensions. { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. @@ -787,6 +789,7 @@

Method Details

"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2. "keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key. }, + "tbsCertificateDigest": "A String", # The hash of the pre-signed certificate, which will be signed by the CA. Corresponds to the TBS Certificate in https://tools.ietf.org/html/rfc5280#section-4.1.2. The field will always be populated. "x509Description": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Describes some of the technical X.509 fields in a certificate. "additionalExtensions": [ # Optional. Describes custom X.509 extensions. { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. @@ -1102,6 +1105,7 @@

Method Details

"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2. "keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key. }, + "tbsCertificateDigest": "A String", # The hash of the pre-signed certificate, which will be signed by the CA. Corresponds to the TBS Certificate in https://tools.ietf.org/html/rfc5280#section-4.1.2. The field will always be populated. "x509Description": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Describes some of the technical X.509 fields in a certificate. "additionalExtensions": [ # Optional. Describes custom X.509 extensions. { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. @@ -1426,6 +1430,7 @@

Method Details

"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2. "keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key. }, + "tbsCertificateDigest": "A String", # The hash of the pre-signed certificate, which will be signed by the CA. Corresponds to the TBS Certificate in https://tools.ietf.org/html/rfc5280#section-4.1.2. The field will always be populated. "x509Description": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Describes some of the technical X.509 fields in a certificate. "additionalExtensions": [ # Optional. Describes custom X.509 extensions. { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. @@ -1730,6 +1735,7 @@

Method Details

"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2. "keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key. }, + "tbsCertificateDigest": "A String", # The hash of the pre-signed certificate, which will be signed by the CA. Corresponds to the TBS Certificate in https://tools.ietf.org/html/rfc5280#section-4.1.2. The field will always be populated. "x509Description": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Describes some of the technical X.509 fields in a certificate. "additionalExtensions": [ # Optional. Describes custom X.509 extensions. { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. @@ -2047,6 +2053,7 @@

Method Details

"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2. "keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key. }, + "tbsCertificateDigest": "A String", # The hash of the pre-signed certificate, which will be signed by the CA. Corresponds to the TBS Certificate in https://tools.ietf.org/html/rfc5280#section-4.1.2. The field will always be populated. "x509Description": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Describes some of the technical X.509 fields in a certificate. "additionalExtensions": [ # Optional. Describes custom X.509 extensions. { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. diff --git a/docs/dyn/redis_v1.projects.locations.clusters.html b/docs/dyn/redis_v1.projects.locations.clusters.html index 6852970e8cd..f8800110f1e 100644 --- a/docs/dyn/redis_v1.projects.locations.clusters.html +++ b/docs/dyn/redis_v1.projects.locations.clusters.html @@ -98,6 +98,9 @@

Instance Methods

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

Updates the metadata and configuration of a specific Redis cluster. Completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

+

+ rescheduleClusterMaintenance(name, body=None, x__xgafv=None)

+

Reschedules upcoming maintenance event.

Method Details

close() @@ -152,6 +155,27 @@

Method Details

}, }, ], + "maintenancePolicy": { # Maintenance policy per cluster. # Optional. ClusterMaintenancePolicy determines when to allow or deny updates. + "createTime": "A String", # Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned. + "updateTime": "A String", # Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated. + "weeklyMaintenanceWindow": [ # Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_window is expected to be one. + { # Time window specified for weekly operations. + "day": "A String", # Allows to define schedule that runs specified day of the week. + "duration": "A String", # Duration of the time window. + "startTime": { # 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`. # Start time of the window in UTC. + "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. + "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + ], + }, + "maintenanceSchedule": { # Upcoming maitenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. + "endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. + "scheduleDeadlineTime": "A String", # Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. + "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. + }, "name": "A String", # Required. Identifier. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` "nodeType": "A String", # Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node. "persistenceConfig": { # Configuration of the persistence functionality. # Optional. Persistence config (RDB, AOF) for the cluster. @@ -320,6 +344,27 @@

Method Details

}, }, ], + "maintenancePolicy": { # Maintenance policy per cluster. # Optional. ClusterMaintenancePolicy determines when to allow or deny updates. + "createTime": "A String", # Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned. + "updateTime": "A String", # Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated. + "weeklyMaintenanceWindow": [ # Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_window is expected to be one. + { # Time window specified for weekly operations. + "day": "A String", # Allows to define schedule that runs specified day of the week. + "duration": "A String", # Duration of the time window. + "startTime": { # 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`. # Start time of the window in UTC. + "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. + "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + ], + }, + "maintenanceSchedule": { # Upcoming maitenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. + "endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. + "scheduleDeadlineTime": "A String", # Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. + "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. + }, "name": "A String", # Required. Identifier. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` "nodeType": "A String", # Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node. "persistenceConfig": { # Configuration of the persistence functionality. # Optional. Persistence config (RDB, AOF) for the cluster. @@ -454,6 +499,27 @@

Method Details

}, }, ], + "maintenancePolicy": { # Maintenance policy per cluster. # Optional. ClusterMaintenancePolicy determines when to allow or deny updates. + "createTime": "A String", # Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned. + "updateTime": "A String", # Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated. + "weeklyMaintenanceWindow": [ # Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_window is expected to be one. + { # Time window specified for weekly operations. + "day": "A String", # Allows to define schedule that runs specified day of the week. + "duration": "A String", # Duration of the time window. + "startTime": { # 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`. # Start time of the window in UTC. + "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. + "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + ], + }, + "maintenanceSchedule": { # Upcoming maitenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. + "endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. + "scheduleDeadlineTime": "A String", # Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. + "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. + }, "name": "A String", # Required. Identifier. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` "nodeType": "A String", # Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node. "persistenceConfig": { # Configuration of the persistence functionality. # Optional. Persistence config (RDB, AOF) for the cluster. @@ -571,6 +637,27 @@

Method Details

}, }, ], + "maintenancePolicy": { # Maintenance policy per cluster. # Optional. ClusterMaintenancePolicy determines when to allow or deny updates. + "createTime": "A String", # Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned. + "updateTime": "A String", # Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated. + "weeklyMaintenanceWindow": [ # Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_window is expected to be one. + { # Time window specified for weekly operations. + "day": "A String", # Allows to define schedule that runs specified day of the week. + "duration": "A String", # Duration of the time window. + "startTime": { # 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`. # Start time of the window in UTC. + "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. + "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + ], + }, + "maintenanceSchedule": { # Upcoming maitenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. + "endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. + "scheduleDeadlineTime": "A String", # Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. + "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. + }, "name": "A String", # Required. Identifier. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` "nodeType": "A String", # Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node. "persistenceConfig": { # Configuration of the persistence functionality. # Optional. Persistence config (RDB, AOF) for the cluster. @@ -650,4 +737,47 @@

Method Details

}
+
+ rescheduleClusterMaintenance(name, body=None, x__xgafv=None) +
Reschedules upcoming maintenance event.
+
+Args:
+  name: string, Required. Redis Cluster instance resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for rescheduling a cluster maintenance.
+  "rescheduleType": "A String", # Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.
+  "scheduleTime": "A String", # Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example `2012-11-15T16:19:00.094Z`.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. }
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/redis_v1beta1.projects.locations.clusters.html b/docs/dyn/redis_v1beta1.projects.locations.clusters.html index 679c359eaa0..34ead2a46a7 100644 --- a/docs/dyn/redis_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/redis_v1beta1.projects.locations.clusters.html @@ -98,6 +98,9 @@

Instance Methods

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

Updates the metadata and configuration of a specific Redis cluster. Completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

+

+ rescheduleClusterMaintenance(name, body=None, x__xgafv=None)

+

Reschedules upcoming maintenance event.

Method Details

close() @@ -152,6 +155,27 @@

Method Details

}, }, ], + "maintenancePolicy": { # Maintenance policy per cluster. # Optional. ClusterMaintenancePolicy determines when to allow or deny updates. + "createTime": "A String", # Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned. + "updateTime": "A String", # Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated. + "weeklyMaintenanceWindow": [ # Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_window is expected to be one. + { # Time window specified for weekly operations. + "day": "A String", # Allows to define schedule that runs specified day of the week. + "duration": "A String", # Duration of the time window. + "startTime": { # 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`. # Start time of the window in UTC. + "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. + "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + ], + }, + "maintenanceSchedule": { # Upcoming maitenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. + "endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. + "scheduleDeadlineTime": "A String", # Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. + "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. + }, "name": "A String", # Required. Identifier. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` "nodeType": "A String", # Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node. "persistenceConfig": { # Configuration of the persistence functionality. # Optional. Persistence config (RDB, AOF) for the cluster. @@ -320,6 +344,27 @@

Method Details

}, }, ], + "maintenancePolicy": { # Maintenance policy per cluster. # Optional. ClusterMaintenancePolicy determines when to allow or deny updates. + "createTime": "A String", # Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned. + "updateTime": "A String", # Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated. + "weeklyMaintenanceWindow": [ # Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_window is expected to be one. + { # Time window specified for weekly operations. + "day": "A String", # Allows to define schedule that runs specified day of the week. + "duration": "A String", # Duration of the time window. + "startTime": { # 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`. # Start time of the window in UTC. + "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. + "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + ], + }, + "maintenanceSchedule": { # Upcoming maitenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. + "endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. + "scheduleDeadlineTime": "A String", # Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. + "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. + }, "name": "A String", # Required. Identifier. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` "nodeType": "A String", # Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node. "persistenceConfig": { # Configuration of the persistence functionality. # Optional. Persistence config (RDB, AOF) for the cluster. @@ -454,6 +499,27 @@

Method Details

}, }, ], + "maintenancePolicy": { # Maintenance policy per cluster. # Optional. ClusterMaintenancePolicy determines when to allow or deny updates. + "createTime": "A String", # Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned. + "updateTime": "A String", # Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated. + "weeklyMaintenanceWindow": [ # Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_window is expected to be one. + { # Time window specified for weekly operations. + "day": "A String", # Allows to define schedule that runs specified day of the week. + "duration": "A String", # Duration of the time window. + "startTime": { # 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`. # Start time of the window in UTC. + "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. + "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + ], + }, + "maintenanceSchedule": { # Upcoming maitenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. + "endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. + "scheduleDeadlineTime": "A String", # Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. + "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. + }, "name": "A String", # Required. Identifier. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` "nodeType": "A String", # Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node. "persistenceConfig": { # Configuration of the persistence functionality. # Optional. Persistence config (RDB, AOF) for the cluster. @@ -571,6 +637,27 @@

Method Details

}, }, ], + "maintenancePolicy": { # Maintenance policy per cluster. # Optional. ClusterMaintenancePolicy determines when to allow or deny updates. + "createTime": "A String", # Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned. + "updateTime": "A String", # Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated. + "weeklyMaintenanceWindow": [ # Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_window is expected to be one. + { # Time window specified for weekly operations. + "day": "A String", # Allows to define schedule that runs specified day of the week. + "duration": "A String", # Duration of the time window. + "startTime": { # 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`. # Start time of the window in UTC. + "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. + "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + ], + }, + "maintenanceSchedule": { # Upcoming maitenance schedule. # Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. + "endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. + "scheduleDeadlineTime": "A String", # Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. + "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. + }, "name": "A String", # Required. Identifier. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` "nodeType": "A String", # Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node. "persistenceConfig": { # Configuration of the persistence functionality. # Optional. Persistence config (RDB, AOF) for the cluster. @@ -650,4 +737,47 @@

Method Details

}
+
+ rescheduleClusterMaintenance(name, body=None, x__xgafv=None) +
Reschedules upcoming maintenance event.
+
+Args:
+  name: string, Required. Redis Cluster instance resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for rescheduling a cluster maintenance.
+  "rescheduleType": "A String", # Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.
+  "scheduleTime": "A String", # Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example `2012-11-15T16:19:00.094Z`.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. }
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/run_v2.projects.locations.services.html b/docs/dyn/run_v2.projects.locations.services.html index 4a220b5b718..def4892e18e 100644 --- a/docs/dyn/run_v2.projects.locations.services.html +++ b/docs/dyn/run_v2.projects.locations.services.html @@ -369,6 +369,9 @@

Method Details

"uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. "updateTime": "A String", # Output only. The last-modified time. "uri": "A String", # Output only. The main URI in which this Service is serving traffic. + "urls": [ # Output only. All URLs serving traffic for this Service. + "A String", + ], } serviceId: string, Required. The unique identifier for the Service. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the service becomes {parent}/services/{service_id}. @@ -698,6 +701,9 @@

Method Details

"uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. "updateTime": "A String", # Output only. The last-modified time. "uri": "A String", # Output only. The main URI in which this Service is serving traffic. + "urls": [ # Output only. All URLs serving traffic for this Service. + "A String", + ], }
@@ -1014,6 +1020,9 @@

Method Details

"uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. "updateTime": "A String", # Output only. The last-modified time. "uri": "A String", # Output only. The main URI in which this Service is serving traffic. + "urls": [ # Output only. All URLs serving traffic for this Service. + "A String", + ], }, ], }
@@ -1287,6 +1296,9 @@

Method Details

"uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. "updateTime": "A String", # Output only. The last-modified time. "uri": "A String", # Output only. The main URI in which this Service is serving traffic. + "urls": [ # Output only. All URLs serving traffic for this Service. + "A String", + ], } allowMissing: boolean, Optional. If set to true, and if the Service does not exist, it will create a new one. The caller must have 'run.services.create' permissions if this is set to true and the Service does not exist. diff --git a/docs/dyn/searchads360_v0.customers.customColumns.html b/docs/dyn/searchads360_v0.customers.customColumns.html index 449e66c8bfb..c3f56cd3e41 100644 --- a/docs/dyn/searchads360_v0.customers.customColumns.html +++ b/docs/dyn/searchads360_v0.customers.customColumns.html @@ -113,6 +113,7 @@

Method Details

], "referencesAttributes": True or False, # Output only. True when the custom column is referring to one or more attributes. "referencesMetrics": True or False, # Output only. True when the custom column is referring to one or more metrics. + "renderType": "A String", # Output only. How the result value of the custom column should be interpreted. "resourceName": "A String", # Immutable. The resource name of the custom column. Custom column resource names have the form: `customers/{customer_id}/customColumns/{custom_column_id}` "valueType": "A String", # Output only. The type of the result value of the custom column. }
@@ -144,6 +145,7 @@

Method Details

], "referencesAttributes": True or False, # Output only. True when the custom column is referring to one or more attributes. "referencesMetrics": True or False, # Output only. True when the custom column is referring to one or more metrics. + "renderType": "A String", # Output only. How the result value of the custom column should be interpreted. "resourceName": "A String", # Immutable. The resource name of the custom column. Custom column resource names have the form: `customers/{customer_id}/customColumns/{custom_column_id}` "valueType": "A String", # Output only. The type of the result value of the custom column. }, diff --git a/docs/dyn/searchads360_v0.customers.searchAds360.html b/docs/dyn/searchads360_v0.customers.searchAds360.html index 46448437b8c..5a32677d2d5 100644 --- a/docs/dyn/searchads360_v0.customers.searchAds360.html +++ b/docs/dyn/searchads360_v0.customers.searchAds360.html @@ -272,6 +272,7 @@

Method Details

"adGroupAdLabel": { # A relationship between an ad group ad and a label. # The ad group ad label referenced in the query. "adGroupAd": "A String", # Immutable. The ad group ad to which the label is attached. "label": "A String", # Immutable. The label assigned to the ad group ad. + "ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the label. "resourceName": "A String", # Immutable. The resource name of the ad group ad label. Ad group ad label resource names have the form: `customers/{customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}~{label_id}` }, "adGroupAsset": { # A link between an ad group and an asset. # The ad group asset referenced in the query. @@ -358,11 +359,13 @@

Method Details

"adGroupCriterionLabel": { # A relationship between an ad group criterion and a label. # The ad group criterion label referenced in the query. "adGroupCriterion": "A String", # Immutable. The ad group criterion to which the label is attached. "label": "A String", # Immutable. The label assigned to the ad group criterion. + "ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the label. "resourceName": "A String", # Immutable. The resource name of the ad group criterion label. Ad group criterion label resource names have the form: `customers/{customer_id}/adGroupCriterionLabels/{ad_group_id}~{criterion_id}~{label_id}` }, "adGroupLabel": { # A relationship between an ad group and a label. # The ad group label referenced in the query. "adGroup": "A String", # Immutable. The ad group to which the label is attached. "label": "A String", # Immutable. The label assigned to the ad group. + "ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the label. "resourceName": "A String", # Immutable. The resource name of the ad group label. Ad group label resource names have the form: `customers/{customer_id}/adGroupLabels/{ad_group_id}~{label_id}` }, "ageRangeView": { # An age range view. # The age range view referenced in the query. @@ -844,6 +847,7 @@

Method Details

"campaignLabel": { # Represents a relationship between a campaign and a label. # The campaign label referenced in the query. "campaign": "A String", # Immutable. The campaign to which the label is attached. "label": "A String", # Immutable. The label assigned to the campaign. + "ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the label. "resourceName": "A String", # Immutable. Name of the resource. Campaign label resource names have the form: `customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}` }, "cartDataSalesView": { # Cart data sales view. # The cart data sales view referenced in the query. @@ -1396,6 +1400,7 @@

Method Details

"adGroupAdLabel": { # A relationship between an ad group ad and a label. # The ad group ad label referenced in the query. "adGroupAd": "A String", # Immutable. The ad group ad to which the label is attached. "label": "A String", # Immutable. The label assigned to the ad group ad. + "ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the label. "resourceName": "A String", # Immutable. The resource name of the ad group ad label. Ad group ad label resource names have the form: `customers/{customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}~{label_id}` }, "adGroupAsset": { # A link between an ad group and an asset. # The ad group asset referenced in the query. @@ -1482,11 +1487,13 @@

Method Details

"adGroupCriterionLabel": { # A relationship between an ad group criterion and a label. # The ad group criterion label referenced in the query. "adGroupCriterion": "A String", # Immutable. The ad group criterion to which the label is attached. "label": "A String", # Immutable. The label assigned to the ad group criterion. + "ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the label. "resourceName": "A String", # Immutable. The resource name of the ad group criterion label. Ad group criterion label resource names have the form: `customers/{customer_id}/adGroupCriterionLabels/{ad_group_id}~{criterion_id}~{label_id}` }, "adGroupLabel": { # A relationship between an ad group and a label. # The ad group label referenced in the query. "adGroup": "A String", # Immutable. The ad group to which the label is attached. "label": "A String", # Immutable. The label assigned to the ad group. + "ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the label. "resourceName": "A String", # Immutable. The resource name of the ad group label. Ad group label resource names have the form: `customers/{customer_id}/adGroupLabels/{ad_group_id}~{label_id}` }, "ageRangeView": { # An age range view. # The age range view referenced in the query. @@ -1968,6 +1975,7 @@

Method Details

"campaignLabel": { # Represents a relationship between a campaign and a label. # The campaign label referenced in the query. "campaign": "A String", # Immutable. The campaign to which the label is attached. "label": "A String", # Immutable. The label assigned to the campaign. + "ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the label. "resourceName": "A String", # Immutable. Name of the resource. Campaign label resource names have the form: `customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}` }, "cartDataSalesView": { # Cart data sales view. # The cart data sales view referenced in the query. diff --git a/docs/dyn/secretmanager_v1.projects.locations.secrets.html b/docs/dyn/secretmanager_v1.projects.locations.secrets.html index 7bde0c995b9..a2a1bcab1c1 100644 --- a/docs/dyn/secretmanager_v1.projects.locations.secrets.html +++ b/docs/dyn/secretmanager_v1.projects.locations.secrets.html @@ -219,7 +219,7 @@

Method Details

}, "topics": [ # Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions. { # A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret. - "name": "A String", # Required. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. + "name": "A String", # Identifier. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. }, ], "ttl": "A String", # Input only. The TTL for the Secret. @@ -275,7 +275,7 @@

Method Details

}, "topics": [ # Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions. { # A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret. - "name": "A String", # Required. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. + "name": "A String", # Identifier. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. }, ], "ttl": "A String", # Input only. The TTL for the Secret. @@ -356,7 +356,7 @@

Method Details

}, "topics": [ # Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions. { # A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret. - "name": "A String", # Required. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. + "name": "A String", # Identifier. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. }, ], "ttl": "A String", # Input only. The TTL for the Secret. @@ -472,7 +472,7 @@

Method Details

}, "topics": [ # Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions. { # A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret. - "name": "A String", # Required. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. + "name": "A String", # Identifier. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. }, ], "ttl": "A String", # Input only. The TTL for the Secret. @@ -546,7 +546,7 @@

Method Details

}, "topics": [ # Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions. { # A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret. - "name": "A String", # Required. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. + "name": "A String", # Identifier. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. }, ], "ttl": "A String", # Input only. The TTL for the Secret. @@ -602,7 +602,7 @@

Method Details

}, "topics": [ # Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions. { # A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret. - "name": "A String", # Required. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. + "name": "A String", # Identifier. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. }, ], "ttl": "A String", # Input only. The TTL for the Secret. diff --git a/docs/dyn/secretmanager_v1.projects.secrets.html b/docs/dyn/secretmanager_v1.projects.secrets.html index e7411d48862..1712ea1c74b 100644 --- a/docs/dyn/secretmanager_v1.projects.secrets.html +++ b/docs/dyn/secretmanager_v1.projects.secrets.html @@ -219,7 +219,7 @@

Method Details

}, "topics": [ # Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions. { # A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret. - "name": "A String", # Required. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. + "name": "A String", # Identifier. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. }, ], "ttl": "A String", # Input only. The TTL for the Secret. @@ -275,7 +275,7 @@

Method Details

}, "topics": [ # Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions. { # A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret. - "name": "A String", # Required. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. + "name": "A String", # Identifier. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. }, ], "ttl": "A String", # Input only. The TTL for the Secret. @@ -356,7 +356,7 @@

Method Details

}, "topics": [ # Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions. { # A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret. - "name": "A String", # Required. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. + "name": "A String", # Identifier. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. }, ], "ttl": "A String", # Input only. The TTL for the Secret. @@ -472,7 +472,7 @@

Method Details

}, "topics": [ # Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions. { # A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret. - "name": "A String", # Required. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. + "name": "A String", # Identifier. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. }, ], "ttl": "A String", # Input only. The TTL for the Secret. @@ -546,7 +546,7 @@

Method Details

}, "topics": [ # Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions. { # A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret. - "name": "A String", # Required. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. + "name": "A String", # Identifier. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. }, ], "ttl": "A String", # Input only. The TTL for the Secret. @@ -602,7 +602,7 @@

Method Details

}, "topics": [ # Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions. { # A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret. - "name": "A String", # Required. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. + "name": "A String", # Identifier. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission. }, ], "ttl": "A String", # Input only. The TTL for the Secret. diff --git a/docs/dyn/servicenetworking_v1.services.html b/docs/dyn/servicenetworking_v1.services.html index e6017a0d929..35bddfe4d04 100644 --- a/docs/dyn/servicenetworking_v1.services.html +++ b/docs/dyn/servicenetworking_v1.services.html @@ -153,6 +153,7 @@

Method Details

"requestedAddress": "A String", # Optional. The starting address of a range. The address must be a valid IPv4 address in the x.x.x.x format. This value combined with the IP prefix range is the CIDR range for the secondary IP range. The range must be within the allocated range that is assigned to the private connection. If the CIDR range isn't available, the call fails. }, ], + "skipRequestedAddressValidation": True or False, # Optional. Skips validating if the requested_address is in use by SN VPC’s peering group. Compute Engine will still perform this check and fail the request if the requested_address is in use. Note that Compute Engine does not check for the existence of dynamic routes when performing this check. Caller of this API should make sure that there are no dynamic routes overlapping with the requested_address/prefix_length IP address range otherwise the created subnet could cause misrouting. "subnetwork": "A String", # Required. A name for the new subnet. For information about the naming requirements, see [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the Compute API documentation. "subnetworkUsers": [ # A list of members that are granted the `roles/servicenetworking.subnetworkAdmin` role on the subnet. "A String", diff --git a/docs/dyn/servicenetworking_v1.services.roles.html b/docs/dyn/servicenetworking_v1.services.roles.html index 7f7f5d8b3ff..5710bf207a0 100644 --- a/docs/dyn/servicenetworking_v1.services.roles.html +++ b/docs/dyn/servicenetworking_v1.services.roles.html @@ -95,7 +95,7 @@

Method Details

"policyBinding": [ # Required. List of policy bindings to add to shared VPC host project. { # Grouping of IAM role and IAM member. "member": "A String", # Required. Member to bind the role with. See /iam/docs/reference/rest/v1/Policy#Binding for how to format each member. Eg. - user:myuser@mydomain.com - serviceAccount:my-service-account@app.gserviceaccount.com - "role": "A String", # Required. Role to apply. Only allowlisted roles can be used at the specified granularity. The role must be one of the following: - 'roles/container.hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute.securityAdmin' applied on the shared VPC host project - 'roles/compute.networkAdmin' applied on the shared VPC host project - 'roles/compute.xpnAdmin' applied on the shared VPC host project - 'roles/dns.admin' applied on the shared VPC host project - 'roles/logging.admin' applied on the shared VPC host project + "role": "A String", # Required. Role to apply. Only allowlisted roles can be used at the specified granularity. The role must be one of the following: - 'roles/container.hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute.securityAdmin' applied on the shared VPC host project - 'roles/compute.networkAdmin' applied on the shared VPC host project - 'roles/tpu.xpnAgent' applied on the shared VPC host project - 'roles/dns.admin' applied on the shared VPC host project - 'roles/logging.admin' applied on the shared VPC host project - 'roles/monitoring.viewer' applied on the shared VPC host project }, ], } diff --git a/docs/dyn/solar_v1.buildingInsights.html b/docs/dyn/solar_v1.buildingInsights.html index 18c1322774e..95523d1fe12 100644 --- a/docs/dyn/solar_v1.buildingInsights.html +++ b/docs/dyn/solar_v1.buildingInsights.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- findClosest(location_latitude=None, location_longitude=None, requiredQuality=None, x__xgafv=None)

+ findClosest(experiments=None, location_latitude=None, location_longitude=None, requiredQuality=None, x__xgafv=None)

Locates the closest building to a query point. Returns an error with code `NOT_FOUND` if there are no buildings within approximately 50m of the query point.

Method Details

@@ -87,10 +87,14 @@

Method Details

- findClosest(location_latitude=None, location_longitude=None, requiredQuality=None, x__xgafv=None) + findClosest(experiments=None, location_latitude=None, location_longitude=None, requiredQuality=None, x__xgafv=None)
Locates the closest building to a query point. Returns an error with code `NOT_FOUND` if there are no buildings within approximately 50m of the query point.
 
 Args:
+  experiments: string, Optional. Specifies the pre-GA features to enable. (repeated)
+    Allowed values
+      EXPERIMENT_UNSPECIFIED - No experiments are specified.
+      EXPANDED_COVERAGE - Expands the geographic region available for querying solar data.
   location_latitude: number, The latitude in degrees. It must be in the range [-90.0, +90.0].
   location_longitude: number, The longitude in degrees. It must be in the range [-180.0, +180.0].
   requiredQuality: string, Optional. The minimum quality level allowed in the results. No result with lower quality than this will be returned. Not specifying this is equivalent to restricting to HIGH quality only.
@@ -99,6 +103,7 @@ 

Method Details

HIGH - Solar data is derived from aerial imagery captured at low-altitude and processed at 0.1 m/pixel. MEDIUM - Solar data is derived from enhanced aerial imagery captured at high-altitude and processed at 0.25 m/pixel. LOW - Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel. + BASE - Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/solar_v1.dataLayers.html b/docs/dyn/solar_v1.dataLayers.html index 5dbb4e9f0a9..8849346c1c4 100644 --- a/docs/dyn/solar_v1.dataLayers.html +++ b/docs/dyn/solar_v1.dataLayers.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- get(exactQualityRequired=None, location_latitude=None, location_longitude=None, pixelSizeMeters=None, radiusMeters=None, requiredQuality=None, view=None, x__xgafv=None)

+ get(exactQualityRequired=None, experiments=None, location_latitude=None, location_longitude=None, pixelSizeMeters=None, radiusMeters=None, requiredQuality=None, view=None, x__xgafv=None)

Gets solar information for a region surrounding a location. Returns an error with code `NOT_FOUND` if the location is outside the coverage area.

Method Details

@@ -87,11 +87,15 @@

Method Details

- get(exactQualityRequired=None, location_latitude=None, location_longitude=None, pixelSizeMeters=None, radiusMeters=None, requiredQuality=None, view=None, x__xgafv=None) + get(exactQualityRequired=None, experiments=None, location_latitude=None, location_longitude=None, pixelSizeMeters=None, radiusMeters=None, requiredQuality=None, view=None, x__xgafv=None)
Gets solar information for a region surrounding a location. Returns an error with code `NOT_FOUND` if the location is outside the coverage area.
 
 Args:
   exactQualityRequired: boolean, Optional. Whether to require exact quality of the imagery. If set to false, the `required_quality` field is interpreted as the minimum required quality, such that HIGH quality imagery may be returned when `required_quality` is set to MEDIUM. If set to true, `required_quality` is interpreted as the exact required quality and only `MEDIUM` quality imagery is returned if `required_quality` is set to `MEDIUM`.
+  experiments: string, Optional. Specifies the pre-GA experiments to enable. (repeated)
+    Allowed values
+      EXPERIMENT_UNSPECIFIED - No experiments are specified.
+      EXPANDED_COVERAGE - Expands the geographic region available for querying solar data.
   location_latitude: number, The latitude in degrees. It must be in the range [-90.0, +90.0].
   location_longitude: number, The longitude in degrees. It must be in the range [-180.0, +180.0].
   pixelSizeMeters: number, Optional. The minimum scale, in meters per pixel, of the data to return. Values of 0.1 (the default, if this field is not set explicitly), 0.25, 0.5, and 1.0 are supported. Imagery components whose normal resolution is less than `pixel_size_meters` will be returned at the resolution specified by `pixel_size_meters`; imagery components whose normal resolution is equal to or greater than `pixel_size_meters` will be returned at that normal resolution.
@@ -102,6 +106,7 @@ 

Method Details

HIGH - Solar data is derived from aerial imagery captured at low-altitude and processed at 0.1 m/pixel. MEDIUM - Solar data is derived from enhanced aerial imagery captured at high-altitude and processed at 0.25 m/pixel. LOW - Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel. + BASE - Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel. view: string, Optional. The desired subset of the data to return. Allowed values DATA_LAYER_VIEW_UNSPECIFIED - Equivalent to FULL. diff --git a/docs/dyn/spanner_v1.projects.instances.backups.html b/docs/dyn/spanner_v1.projects.instances.backups.html index 327fd75e69c..0a4725806ea 100644 --- a/docs/dyn/spanner_v1.projects.instances.backups.html +++ b/docs/dyn/spanner_v1.projects.instances.backups.html @@ -404,7 +404,7 @@

Method Details

Args: parent: string, Required. The instance to list backups from. Values are of the form `projects//instances/`. (required) - filter: string, An expression that filters the list of returned backups. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Backup are eligible for filtering: * `name` * `database` * `state` * `create_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `version_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `size_bytes` You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `name:Howl` - The backup's name contains the string "howl". * `database:prod` - The database's name contains the string "prod". * `state:CREATING` - The backup is pending creation. * `state:READY` - The backup is fully created and ready for use. * `(name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")` - The backup name contains the string "howl" and `create_time` of the backup is before 2018-03-28T14:50:00Z. * `expire_time < \"2018-03-28T14:50:00Z\"` - The backup `expire_time` is before 2018-03-28T14:50:00Z. * `size_bytes > 10000000000` - The backup's size is greater than 10GB + filter: string, An expression that filters the list of returned backups. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Backup are eligible for filtering: * `name` * `database` * `state` * `create_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `version_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `size_bytes` * `backup_schedules` You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `name:Howl` - The backup's name contains the string "howl". * `database:prod` - The database's name contains the string "prod". * `state:CREATING` - The backup is pending creation. * `state:READY` - The backup is fully created and ready for use. * `(name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")` - The backup name contains the string "howl" and `create_time` of the backup is before 2018-03-28T14:50:00Z. * `expire_time < \"2018-03-28T14:50:00Z\"` - The backup `expire_time` is before 2018-03-28T14:50:00Z. * `size_bytes > 10000000000` - The backup's size is greater than 10GB * `backup_schedules:daily` - The backup is created from a schedule with "daily" in its name. pageSize: integer, Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. pageToken: string, If non-empty, `page_token` should contain a next_page_token from a previous ListBackupsResponse to the same `parent` and with the same `filter`. x__xgafv: string, V1 error format. diff --git a/docs/dyn/sqladmin_v1.instances.html b/docs/dyn/sqladmin_v1.instances.html index 8afec946e9b..9944481e9b3 100644 --- a/docs/dyn/sqladmin_v1.instances.html +++ b/docs/dyn/sqladmin_v1.instances.html @@ -348,6 +348,7 @@

Method Details

"kind": "A String", # This is always `sql#cloneContext`. "pitrTimestampMs": "A String", # Reserved for future use. "pointInTime": "A String", # Timestamp, if specified, identifies the time to which the source instance is cloned. + "preferredSecondaryZone": "A String", # Optional. Copy clone and point-in-time recovery clone of a regional instance in the specified zones. If not specified, clone to the same secondary zone as the source instance. This value cannot be the same as the preferred_zone field. This field applies to all DB types. "preferredZone": "A String", # Optional. Copy clone and point-in-time recovery clone of an instance to the specified zone. If no zone is specified, clone to the same primary zone as the source instance. This field applies to all DB types. }, } diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html index 4156d3ae8d4..9042856271a 100644 --- a/docs/dyn/sqladmin_v1beta4.instances.html +++ b/docs/dyn/sqladmin_v1beta4.instances.html @@ -348,6 +348,7 @@

Method Details

"kind": "A String", # This is always `sql#cloneContext`. "pitrTimestampMs": "A String", # Reserved for future use. "pointInTime": "A String", # Timestamp, if specified, identifies the time to which the source instance is cloned. + "preferredSecondaryZone": "A String", # Optional. Copy clone and point-in-time recovery clone of a regional instance in the specified zones. If not specified, clone to the same secondary zone as the source instance. This value cannot be the same as the preferred_zone field. "preferredZone": "A String", # Optional. Copy clone and point-in-time recovery clone of an instance to the specified zone. If no zone is specified, clone to the same primary zone as the source instance. }, } diff --git a/docs/dyn/storage_v1.buckets.html b/docs/dyn/storage_v1.buckets.html index fd665edaf41..feaec8d7d1b 100644 --- a/docs/dyn/storage_v1.buckets.html +++ b/docs/dyn/storage_v1.buckets.html @@ -248,6 +248,7 @@

Method Details

}, "etag": "A String", # HTTP 1.1 Entity tag for the bucket. "generation": "A String", # The generation of this bucket. + "hardDeleteTime": "A String", # The hard delete time of the bucket in RFC 3339 format. "hierarchicalNamespace": { # The bucket's hierarchical namespace configuration. "enabled": True or False, # When set to true, hierarchical namespace is enabled for this bucket. }, @@ -342,6 +343,7 @@

Method Details

"effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format. "retentionDurationSeconds": "A String", # The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. }, + "softDeleteTime": "A String", # The soft delete time of the bucket in RFC 3339 format. "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see [Storage Classes](https://cloud.google.com/storage/docs/storage-classes). "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. "updated": "A String", # The modification time of the bucket in RFC 3339 format. @@ -539,6 +541,7 @@

Method Details

}, "etag": "A String", # HTTP 1.1 Entity tag for the bucket. "generation": "A String", # The generation of this bucket. + "hardDeleteTime": "A String", # The hard delete time of the bucket in RFC 3339 format. "hierarchicalNamespace": { # The bucket's hierarchical namespace configuration. "enabled": True or False, # When set to true, hierarchical namespace is enabled for this bucket. }, @@ -633,6 +636,7 @@

Method Details

"effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format. "retentionDurationSeconds": "A String", # The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. }, + "softDeleteTime": "A String", # The soft delete time of the bucket in RFC 3339 format. "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see [Storage Classes](https://cloud.google.com/storage/docs/storage-classes). "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. "updated": "A String", # The modification time of the bucket in RFC 3339 format. @@ -765,6 +769,7 @@

Method Details

}, "etag": "A String", # HTTP 1.1 Entity tag for the bucket. "generation": "A String", # The generation of this bucket. + "hardDeleteTime": "A String", # The hard delete time of the bucket in RFC 3339 format. "hierarchicalNamespace": { # The bucket's hierarchical namespace configuration. "enabled": True or False, # When set to true, hierarchical namespace is enabled for this bucket. }, @@ -859,6 +864,7 @@

Method Details

"effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format. "retentionDurationSeconds": "A String", # The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. }, + "softDeleteTime": "A String", # The soft delete time of the bucket in RFC 3339 format. "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see [Storage Classes](https://cloud.google.com/storage/docs/storage-classes). "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. "updated": "A String", # The modification time of the bucket in RFC 3339 format. @@ -988,6 +994,7 @@

Method Details

}, "etag": "A String", # HTTP 1.1 Entity tag for the bucket. "generation": "A String", # The generation of this bucket. + "hardDeleteTime": "A String", # The hard delete time of the bucket in RFC 3339 format. "hierarchicalNamespace": { # The bucket's hierarchical namespace configuration. "enabled": True or False, # When set to true, hierarchical namespace is enabled for this bucket. }, @@ -1082,6 +1089,7 @@

Method Details

"effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format. "retentionDurationSeconds": "A String", # The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. }, + "softDeleteTime": "A String", # The soft delete time of the bucket in RFC 3339 format. "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see [Storage Classes](https://cloud.google.com/storage/docs/storage-classes). "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. "updated": "A String", # The modification time of the bucket in RFC 3339 format. @@ -1220,6 +1228,7 @@

Method Details

}, "etag": "A String", # HTTP 1.1 Entity tag for the bucket. "generation": "A String", # The generation of this bucket. + "hardDeleteTime": "A String", # The hard delete time of the bucket in RFC 3339 format. "hierarchicalNamespace": { # The bucket's hierarchical namespace configuration. "enabled": True or False, # When set to true, hierarchical namespace is enabled for this bucket. }, @@ -1314,6 +1323,7 @@

Method Details

"effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format. "retentionDurationSeconds": "A String", # The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. }, + "softDeleteTime": "A String", # The soft delete time of the bucket in RFC 3339 format. "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see [Storage Classes](https://cloud.google.com/storage/docs/storage-classes). "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. "updated": "A String", # The modification time of the bucket in RFC 3339 format. @@ -1431,6 +1441,7 @@

Method Details

}, "etag": "A String", # HTTP 1.1 Entity tag for the bucket. "generation": "A String", # The generation of this bucket. + "hardDeleteTime": "A String", # The hard delete time of the bucket in RFC 3339 format. "hierarchicalNamespace": { # The bucket's hierarchical namespace configuration. "enabled": True or False, # When set to true, hierarchical namespace is enabled for this bucket. }, @@ -1525,6 +1536,7 @@

Method Details

"effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format. "retentionDurationSeconds": "A String", # The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. }, + "softDeleteTime": "A String", # The soft delete time of the bucket in RFC 3339 format. "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see [Storage Classes](https://cloud.google.com/storage/docs/storage-classes). "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. "updated": "A String", # The modification time of the bucket in RFC 3339 format. @@ -1658,6 +1670,7 @@

Method Details

}, "etag": "A String", # HTTP 1.1 Entity tag for the bucket. "generation": "A String", # The generation of this bucket. + "hardDeleteTime": "A String", # The hard delete time of the bucket in RFC 3339 format. "hierarchicalNamespace": { # The bucket's hierarchical namespace configuration. "enabled": True or False, # When set to true, hierarchical namespace is enabled for this bucket. }, @@ -1752,6 +1765,7 @@

Method Details

"effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format. "retentionDurationSeconds": "A String", # The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. }, + "softDeleteTime": "A String", # The soft delete time of the bucket in RFC 3339 format. "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see [Storage Classes](https://cloud.google.com/storage/docs/storage-classes). "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. "updated": "A String", # The modification time of the bucket in RFC 3339 format. @@ -2015,6 +2029,7 @@

Method Details

}, "etag": "A String", # HTTP 1.1 Entity tag for the bucket. "generation": "A String", # The generation of this bucket. + "hardDeleteTime": "A String", # The hard delete time of the bucket in RFC 3339 format. "hierarchicalNamespace": { # The bucket's hierarchical namespace configuration. "enabled": True or False, # When set to true, hierarchical namespace is enabled for this bucket. }, @@ -2109,6 +2124,7 @@

Method Details

"effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format. "retentionDurationSeconds": "A String", # The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. }, + "softDeleteTime": "A String", # The soft delete time of the bucket in RFC 3339 format. "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see [Storage Classes](https://cloud.google.com/storage/docs/storage-classes). "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. "updated": "A String", # The modification time of the bucket in RFC 3339 format. @@ -2242,6 +2258,7 @@

Method Details

}, "etag": "A String", # HTTP 1.1 Entity tag for the bucket. "generation": "A String", # The generation of this bucket. + "hardDeleteTime": "A String", # The hard delete time of the bucket in RFC 3339 format. "hierarchicalNamespace": { # The bucket's hierarchical namespace configuration. "enabled": True or False, # When set to true, hierarchical namespace is enabled for this bucket. }, @@ -2336,6 +2353,7 @@

Method Details

"effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format. "retentionDurationSeconds": "A String", # The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. }, + "softDeleteTime": "A String", # The soft delete time of the bucket in RFC 3339 format. "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see [Storage Classes](https://cloud.google.com/storage/docs/storage-classes). "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. "updated": "A String", # The modification time of the bucket in RFC 3339 format. diff --git a/docs/dyn/texttospeech_v1.projects.locations.html b/docs/dyn/texttospeech_v1.projects.locations.html index 806ff7265d8..f4c827c013f 100644 --- a/docs/dyn/texttospeech_v1.projects.locations.html +++ b/docs/dyn/texttospeech_v1.projects.locations.html @@ -111,7 +111,7 @@

Method Details

"speakingRate": 3.14, # Optional. Input only. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. "volumeGainDb": 3.14, # Optional. Input only. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. Strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. }, - "input": { # Contains text input to be synthesized. Either `text` or `ssml` must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 bytes. # Required. The Synthesizer requires either plain text or SSML as input. While Long Audio is in preview, SSML is temporarily unsupported. + "input": { # Contains text input to be synthesized. Either `text` or `ssml` must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 bytes. # Required. The Synthesizer requires either plain text or SSML as input. "ssml": "A String", # The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml). "text": "A String", # The raw text to be synthesized. }, diff --git a/docs/dyn/texttospeech_v1beta1.projects.locations.html b/docs/dyn/texttospeech_v1beta1.projects.locations.html index 8cb8effb4e6..00304563c69 100644 --- a/docs/dyn/texttospeech_v1beta1.projects.locations.html +++ b/docs/dyn/texttospeech_v1beta1.projects.locations.html @@ -111,7 +111,7 @@

Method Details

"speakingRate": 3.14, # Optional. Input only. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. "volumeGainDb": 3.14, # Optional. Input only. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. Strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. }, - "input": { # Contains text input to be synthesized. Either `text` or `ssml` must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 bytes. # Required. The Synthesizer requires either plain text or SSML as input. While Long Audio is in preview, SSML is temporarily unsupported. + "input": { # Contains text input to be synthesized. Either `text` or `ssml` must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 bytes. # Required. The Synthesizer requires either plain text or SSML as input. "ssml": "A String", # The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml). "text": "A String", # The raw text to be synthesized. }, diff --git a/docs/dyn/translate_v3.projects.locations.datasets.examples.html b/docs/dyn/translate_v3.projects.locations.datasets.examples.html index b0f4db30d10..9ae9dfc2824 100644 --- a/docs/dyn/translate_v3.projects.locations.datasets.examples.html +++ b/docs/dyn/translate_v3.projects.locations.datasets.examples.html @@ -109,7 +109,7 @@

Method Details

{ # Response message for ListExamples. "examples": [ # The sentence pairs. { # A sentence pair. - "name": "A String", # Output only. The resource name of the example, in form of `projects/{project-number-or-id}/locations/{location_id}/datasets/{dataset_id}/examples/{example_id}' + "name": "A String", # Output only. The resource name of the example, in form of `projects/{project-number-or-id}/locations/{location_id}/datasets/{dataset_id}/examples/{example_id}` "sourceText": "A String", # Sentence in source language. "targetText": "A String", # Sentence in target language. "usage": "A String", # Output only. Usage of the sentence pair. Options are TRAIN|VALIDATION|TEST. diff --git a/docs/dyn/translate_v3.projects.locations.glossaries.glossaryEntries.html b/docs/dyn/translate_v3.projects.locations.glossaries.glossaryEntries.html index 30d26501d18..b5535cb5808 100644 --- a/docs/dyn/translate_v3.projects.locations.glossaries.glossaryEntries.html +++ b/docs/dyn/translate_v3.projects.locations.glossaries.glossaryEntries.html @@ -112,7 +112,7 @@

Method Details

{ # Represents a single entry in a glossary. "description": "A String", # Describes the glossary entry. - "name": "A String", # Identifier. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" + "name": "A String", # Identifier. The resource name of the entry. Format: `projects/*/locations/*/glossaries/*/glossaryEntries/*` "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary. "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text, "languageCode": "A String", # The language for this glossary term. @@ -143,7 +143,7 @@

Method Details

{ # Represents a single entry in a glossary. "description": "A String", # Describes the glossary entry. - "name": "A String", # Identifier. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" + "name": "A String", # Identifier. The resource name of the entry. Format: `projects/*/locations/*/glossaries/*/glossaryEntries/*` "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary. "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text, "languageCode": "A String", # The language for this glossary term. @@ -199,7 +199,7 @@

Method Details

{ # Represents a single entry in a glossary. "description": "A String", # Describes the glossary entry. - "name": "A String", # Identifier. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" + "name": "A String", # Identifier. The resource name of the entry. Format: `projects/*/locations/*/glossaries/*/glossaryEntries/*` "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary. "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text, "languageCode": "A String", # The language for this glossary term. @@ -241,7 +241,7 @@

Method Details

"glossaryEntries": [ # Optional. The Glossary Entries { # Represents a single entry in a glossary. "description": "A String", # Describes the glossary entry. - "name": "A String", # Identifier. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" + "name": "A String", # Identifier. The resource name of the entry. Format: `projects/*/locations/*/glossaries/*/glossaryEntries/*` "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary. "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text, "languageCode": "A String", # The language for this glossary term. @@ -285,13 +285,13 @@

Method Details

Updates a glossary entry.
 
 Args:
-  name: string, Identifier. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" (required)
+  name: string, Identifier. The resource name of the entry. Format: `projects/*/locations/*/glossaries/*/glossaryEntries/*` (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Represents a single entry in a glossary.
   "description": "A String", # Describes the glossary entry.
-  "name": "A String", # Identifier. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*"
+  "name": "A String", # Identifier. The resource name of the entry. Format: `projects/*/locations/*/glossaries/*/glossaryEntries/*`
   "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary.
     "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text,
       "languageCode": "A String", # The language for this glossary term.
@@ -322,7 +322,7 @@ 

Method Details

{ # Represents a single entry in a glossary. "description": "A String", # Describes the glossary entry. - "name": "A String", # Identifier. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" + "name": "A String", # Identifier. The resource name of the entry. Format: `projects/*/locations/*/glossaries/*/glossaryEntries/*` "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary. "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text, "languageCode": "A String", # The language for this glossary term. diff --git a/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.html b/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.html index b240fc117e2..cec27c7215a 100644 --- a/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.html +++ b/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.html @@ -93,6 +93,9 @@

Instance Methods

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

Creates a new execution using the latest revision of the given workflow. For more information, see Execute a workflow.

+

+ deleteExecutionHistory(name, body=None, x__xgafv=None)

+

Deletes all step entries for an execution.

exportData(name, x__xgafv=None)

Returns all metadata stored about an execution, excluding most data that is already accessible using other API methods.

@@ -291,6 +294,30 @@

Method Details

}
+
+ deleteExecutionHistory(name, body=None, x__xgafv=None) +
Deletes all step entries for an execution.
+
+Args:
+  name: string, Required. Name of the execution for which step entries should be deleted. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for the DeleteExecutionHistory method.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
exportData(name, x__xgafv=None)
Returns all metadata stored about an execution, excluding most data that is already accessible using other API methods.
diff --git a/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.stepEntries.html b/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.stepEntries.html
index 2593f500cdd..b21c3fa9987 100644
--- a/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.stepEntries.html
+++ b/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.stepEntries.html
@@ -78,10 +78,10 @@ 

Instance Methods

close()

Close httplib2 connections.

- get(name, x__xgafv=None)

+ get(name, view=None, x__xgafv=None)

Gets a step entry.

- list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, skip=None, x__xgafv=None)

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, skip=None, view=None, x__xgafv=None)

Lists step entries for the corresponding workflow execution. Returned entries are ordered by their create_time.

list_next()

@@ -93,11 +93,16 @@

Method Details

- get(name, x__xgafv=None) + get(name, view=None, x__xgafv=None)
Gets a step entry.
 
 Args:
   name: string, Required. The name of the step entry to retrieve. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/{step_entry} (required)
+  view: string, Deprecated field.
+    Allowed values
+      EXECUTION_ENTRY_VIEW_UNSPECIFIED - The default/unset value.
+      EXECUTION_ENTRY_VIEW_BASIC - Include basic information in the step entries. All fields in StepEntry are returned except for variable_data.
+      EXECUTION_ENTRY_VIEW_DETAILED - Include all data.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -132,20 +137,30 @@ 

Method Details

}, "stepType": "A String", # Output only. The type of the step this step entry belongs to. "updateTime": "A String", # Output only. The most recently updated time of the step entry. + "variableData": { # VariableData contains the variable data for this step. # Output only. The VariableData associated to this step. + "variables": { # Variables that are associated with this step. + "a_key": "", + }, + }, }
- list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, skip=None, x__xgafv=None) + list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, skip=None, view=None, x__xgafv=None)
Lists step entries for the corresponding workflow execution. Returned entries are ordered by their create_time.
 
 Args:
-  parent: string, Required. Name of the workflow execution to list entries for. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/ (required)
-  filter: string, Optional. Filters applied to the `[StepEntries.ListStepEntries]` results. The following fields are supported for filtering: `entryId`, `createTime`, `updateTime`, `routine`, `step`, `stepType`, `state`. For details, see AIP-160. For example, if you are using the Google APIs Explorer: `state="SUCCEEDED"` or `createTime>"2023-08-01" AND state="FAILED"`
+  parent: string, Required. Name of the workflow execution to list entries for. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} (required)
+  filter: string, Optional. Filters applied to the `[StepEntries.ListStepEntries]` results. The following fields are supported for filtering: `entryId`, `createTime`, `updateTime`, `routine`, `step`, `stepType`, `parent`, `state`. For details, see AIP-160. For example, if you are using the Google APIs Explorer: `state="SUCCEEDED"` or `createTime>"2023-08-01" AND state="FAILED"`
   orderBy: string, Optional. Comma-separated list of fields that specify the ordering applied to the `[StepEntries.ListStepEntries]` results. By default the ordering is based on ascending `entryId`. The following fields are supported for ordering: `entryId`, `createTime`, `updateTime`, `routine`, `step`, `stepType`, `state`. For details, see AIP-132.
   pageSize: integer, Optional. Number of step entries to return per call. The default max is 1000.
   pageToken: string, Optional. A page token, received from a previous `ListStepEntries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListStepEntries` must match the call that provided the page token.
   skip: integer, Optional. The number of step entries to skip. It can be used with or without a pageToken. If used with a pageToken, then it indicates the number of step entries to skip starting from the requested page.
+  view: string, Deprecated field.
+    Allowed values
+      EXECUTION_ENTRY_VIEW_UNSPECIFIED - The default/unset value.
+      EXECUTION_ENTRY_VIEW_BASIC - Include basic information in the step entries. All fields in StepEntry are returned except for variable_data.
+      EXECUTION_ENTRY_VIEW_DETAILED - Include all data.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -183,6 +198,11 @@ 

Method Details

}, "stepType": "A String", # Output only. The type of the step this step entry belongs to. "updateTime": "A String", # Output only. The most recently updated time of the step entry. + "variableData": { # VariableData contains the variable data for this step. # Output only. The VariableData associated to this step. + "variables": { # Variables that are associated with this step. + "a_key": "", + }, + }, }, ], "totalSize": 42, # Indicates the total number of StepEntries that matched the request filter. For running executions, this number shows the number of StepEntries that are executed thus far. diff --git a/docs/dyn/workflows_v1.projects.locations.workflows.html b/docs/dyn/workflows_v1.projects.locations.workflows.html index d6f2c3f3768..a3a687d1722 100644 --- a/docs/dyn/workflows_v1.projects.locations.workflows.html +++ b/docs/dyn/workflows_v1.projects.locations.workflows.html @@ -128,6 +128,7 @@

Method Details

"cryptoKeyName": "A String", # Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted. "cryptoKeyVersion": "A String", # Output only. The resource name of a KMS crypto key version used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion} "description": "A String", # Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision. + "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this workflow. "labels": { # Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision. "a_key": "A String", }, @@ -239,6 +240,7 @@

Method Details

"cryptoKeyName": "A String", # Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted. "cryptoKeyVersion": "A String", # Output only. The resource name of a KMS crypto key version used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion} "description": "A String", # Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision. + "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this workflow. "labels": { # Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision. "a_key": "A String", }, @@ -295,6 +297,7 @@

Method Details

"cryptoKeyName": "A String", # Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted. "cryptoKeyVersion": "A String", # Output only. The resource name of a KMS crypto key version used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion} "description": "A String", # Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision. + "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this workflow. "labels": { # Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision. "a_key": "A String", }, @@ -348,6 +351,7 @@

Method Details

"cryptoKeyName": "A String", # Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted. "cryptoKeyVersion": "A String", # Output only. The resource name of a KMS crypto key version used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion} "description": "A String", # Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision. + "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this workflow. "labels": { # Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision. "a_key": "A String", }, @@ -419,6 +423,7 @@

Method Details

"cryptoKeyName": "A String", # Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted. "cryptoKeyVersion": "A String", # Output only. The resource name of a KMS crypto key version used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion} "description": "A String", # Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision. + "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this workflow. "labels": { # Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision. "a_key": "A String", }, diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html index 18c9c89f775..1bd66d046c5 100644 --- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html +++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html @@ -187,6 +187,7 @@

Method Details

}, ], "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. + "grantWorkstationAdminRoleOnCreate": True or False, # Optional. Grant creator of a workstation `roles/workstations.policyAdmin` role along with `roles/workstations.user` role on the workstation created by them. This allows workstation users to share access to either their entire workstation, or individual ports. Defaults to false. "host": { # Runtime host for a workstation. # Optional. Runtime host for the workstation. "gceInstance": { # A runtime using a Compute Engine instance. # Specifies a Compute Engine instance as the host. "accelerators": [ # Optional. A list of the type and count of accelerator cards attached to the instance. @@ -226,6 +227,7 @@

Method Details

"labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, + "maxUsableWorkstations": 42, # Optional. Maximum number of workstations under this config a user can have `workstations.workstation.use` permission on. Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by: - granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or - having a user with that permission create a workstation and granting another user `workstations.workstation.use` permission on that workstation. If not specified defaults to 0 which indicates unlimited. "name": "A String", # Identifier. Full name of this workstation configuration. "persistentDirectories": [ # Optional. Directories to persist across workstation sessions. { # A directory to persist across workstation sessions. @@ -394,6 +396,7 @@

Method Details

}, ], "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. + "grantWorkstationAdminRoleOnCreate": True or False, # Optional. Grant creator of a workstation `roles/workstations.policyAdmin` role along with `roles/workstations.user` role on the workstation created by them. This allows workstation users to share access to either their entire workstation, or individual ports. Defaults to false. "host": { # Runtime host for a workstation. # Optional. Runtime host for the workstation. "gceInstance": { # A runtime using a Compute Engine instance. # Specifies a Compute Engine instance as the host. "accelerators": [ # Optional. A list of the type and count of accelerator cards attached to the instance. @@ -433,6 +436,7 @@

Method Details

"labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, + "maxUsableWorkstations": 42, # Optional. Maximum number of workstations under this config a user can have `workstations.workstation.use` permission on. Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by: - granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or - having a user with that permission create a workstation and granting another user `workstations.workstation.use` permission on that workstation. If not specified defaults to 0 which indicates unlimited. "name": "A String", # Identifier. Full name of this workstation configuration. "persistentDirectories": [ # Optional. Directories to persist across workstation sessions. { # A directory to persist across workstation sessions. @@ -589,6 +593,7 @@

Method Details

}, ], "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. + "grantWorkstationAdminRoleOnCreate": True or False, # Optional. Grant creator of a workstation `roles/workstations.policyAdmin` role along with `roles/workstations.user` role on the workstation created by them. This allows workstation users to share access to either their entire workstation, or individual ports. Defaults to false. "host": { # Runtime host for a workstation. # Optional. Runtime host for the workstation. "gceInstance": { # A runtime using a Compute Engine instance. # Specifies a Compute Engine instance as the host. "accelerators": [ # Optional. A list of the type and count of accelerator cards attached to the instance. @@ -628,6 +633,7 @@

Method Details

"labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, + "maxUsableWorkstations": 42, # Optional. Maximum number of workstations under this config a user can have `workstations.workstation.use` permission on. Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by: - granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or - having a user with that permission create a workstation and granting another user `workstations.workstation.use` permission on that workstation. If not specified defaults to 0 which indicates unlimited. "name": "A String", # Identifier. Full name of this workstation configuration. "persistentDirectories": [ # Optional. Directories to persist across workstation sessions. { # A directory to persist across workstation sessions. @@ -738,6 +744,7 @@

Method Details

}, ], "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. + "grantWorkstationAdminRoleOnCreate": True or False, # Optional. Grant creator of a workstation `roles/workstations.policyAdmin` role along with `roles/workstations.user` role on the workstation created by them. This allows workstation users to share access to either their entire workstation, or individual ports. Defaults to false. "host": { # Runtime host for a workstation. # Optional. Runtime host for the workstation. "gceInstance": { # A runtime using a Compute Engine instance. # Specifies a Compute Engine instance as the host. "accelerators": [ # Optional. A list of the type and count of accelerator cards attached to the instance. @@ -777,6 +784,7 @@

Method Details

"labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, + "maxUsableWorkstations": 42, # Optional. Maximum number of workstations under this config a user can have `workstations.workstation.use` permission on. Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by: - granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or - having a user with that permission create a workstation and granting another user `workstations.workstation.use` permission on that workstation. If not specified defaults to 0 which indicates unlimited. "name": "A String", # Identifier. Full name of this workstation configuration. "persistentDirectories": [ # Optional. Directories to persist across workstation sessions. { # A directory to persist across workstation sessions. @@ -902,6 +910,7 @@

Method Details

}, ], "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. + "grantWorkstationAdminRoleOnCreate": True or False, # Optional. Grant creator of a workstation `roles/workstations.policyAdmin` role along with `roles/workstations.user` role on the workstation created by them. This allows workstation users to share access to either their entire workstation, or individual ports. Defaults to false. "host": { # Runtime host for a workstation. # Optional. Runtime host for the workstation. "gceInstance": { # A runtime using a Compute Engine instance. # Specifies a Compute Engine instance as the host. "accelerators": [ # Optional. A list of the type and count of accelerator cards attached to the instance. @@ -941,6 +950,7 @@

Method Details

"labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, + "maxUsableWorkstations": 42, # Optional. Maximum number of workstations under this config a user can have `workstations.workstation.use` permission on. Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by: - granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or - having a user with that permission create a workstation and granting another user `workstations.workstation.use` permission on that workstation. If not specified defaults to 0 which indicates unlimited. "name": "A String", # Identifier. Full name of this workstation configuration. "persistentDirectories": [ # Optional. Directories to persist across workstation sessions. { # A directory to persist across workstation sessions. diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html index 70cca261c9f..19c511a5fb3 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html @@ -187,6 +187,7 @@

Method Details

}, ], "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. + "grantWorkstationAdminRoleOnCreate": True or False, # Optional. Grant creator of a workstation `roles/workstations.policyAdmin` role along with `roles/workstations.user` role on the workstation created by them. This allows workstation users to share access to either their entire workstation, or individual ports. Defaults to false. "host": { # Runtime host for a workstation. # Optional. Runtime host for the workstation. "gceInstance": { # A runtime using a Compute Engine instance. # Specifies a Compute Engine instance as the host. "accelerators": [ # Optional. A list of the type and count of accelerator cards attached to the instance. @@ -415,6 +416,7 @@

Method Details

}, ], "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. + "grantWorkstationAdminRoleOnCreate": True or False, # Optional. Grant creator of a workstation `roles/workstations.policyAdmin` role along with `roles/workstations.user` role on the workstation created by them. This allows workstation users to share access to either their entire workstation, or individual ports. Defaults to false. "host": { # Runtime host for a workstation. # Optional. Runtime host for the workstation. "gceInstance": { # A runtime using a Compute Engine instance. # Specifies a Compute Engine instance as the host. "accelerators": [ # Optional. A list of the type and count of accelerator cards attached to the instance. @@ -631,6 +633,7 @@

Method Details

}, ], "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. + "grantWorkstationAdminRoleOnCreate": True or False, # Optional. Grant creator of a workstation `roles/workstations.policyAdmin` role along with `roles/workstations.user` role on the workstation created by them. This allows workstation users to share access to either their entire workstation, or individual ports. Defaults to false. "host": { # Runtime host for a workstation. # Optional. Runtime host for the workstation. "gceInstance": { # A runtime using a Compute Engine instance. # Specifies a Compute Engine instance as the host. "accelerators": [ # Optional. A list of the type and count of accelerator cards attached to the instance. @@ -801,6 +804,7 @@

Method Details

}, ], "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. + "grantWorkstationAdminRoleOnCreate": True or False, # Optional. Grant creator of a workstation `roles/workstations.policyAdmin` role along with `roles/workstations.user` role on the workstation created by them. This allows workstation users to share access to either their entire workstation, or individual ports. Defaults to false. "host": { # Runtime host for a workstation. # Optional. Runtime host for the workstation. "gceInstance": { # A runtime using a Compute Engine instance. # Specifies a Compute Engine instance as the host. "accelerators": [ # Optional. A list of the type and count of accelerator cards attached to the instance. @@ -986,6 +990,7 @@

Method Details

}, ], "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. + "grantWorkstationAdminRoleOnCreate": True or False, # Optional. Grant creator of a workstation `roles/workstations.policyAdmin` role along with `roles/workstations.user` role on the workstation created by them. This allows workstation users to share access to either their entire workstation, or individual ports. Defaults to false. "host": { # Runtime host for a workstation. # Optional. Runtime host for the workstation. "gceInstance": { # A runtime using a Compute Engine instance. # Specifies a Compute Engine instance as the host. "accelerators": [ # Optional. A list of the type and count of accelerator cards attached to the instance. diff --git a/googleapiclient/discovery_cache/documents/accessapproval.v1.json b/googleapiclient/discovery_cache/documents/accessapproval.v1.json index 0e2ab5e6770..358f2ae0f8b 100644 --- a/googleapiclient/discovery_cache/documents/accessapproval.v1.json +++ b/googleapiclient/discovery_cache/documents/accessapproval.v1.json @@ -913,7 +913,7 @@ } } }, -"revision": "20240705", +"revision": "20240820", "rootUrl": "https://accessapproval.googleapis.com/", "schemas": { "AccessApprovalServiceAccount": { @@ -1076,6 +1076,10 @@ "format": "google-datetime", "type": "string" }, +"requestedAugmentedInfo": { +"$ref": "AugmentedInfo", +"description": "This field contains the augmented information of the request." +}, "requestedDuration": { "description": "The requested access duration.", "format": "google-duration", @@ -1147,6 +1151,17 @@ }, "type": "object" }, +"AugmentedInfo": { +"description": "This field contains the augmented information of the request.", +"id": "AugmentedInfo", +"properties": { +"command": { +"description": "For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).", +"type": "string" +} +}, +"type": "object" +}, "DismissApprovalRequestMessage": { "description": "Request to dismiss an approval request.", "id": "DismissApprovalRequestMessage", diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json index c58d093c351..9ee3f8a9cae 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json @@ -4886,7 +4886,7 @@ } } }, -"revision": "20240731", +"revision": "20240821", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { @@ -6037,7 +6037,7 @@ "type": "string" }, "project": { -"description": "Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'", +"description": "Immutable. The linked Google Cloud project resource name. Currently, this API always uses a project number, but may use project IDs in the future. Format: 'projects/{project number}' Example: 'projects/1234'", "type": "string" }, "streamingExportEnabled": { diff --git a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json index 46e4d7ae9c9..e12299e9881 100644 --- a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json @@ -2654,7 +2654,7 @@ } } }, -"revision": "20240704", +"revision": "20240820", "rootUrl": "https://androidenterprise.googleapis.com/", "schemas": { "Administrator": { @@ -3374,7 +3374,7 @@ "type": "object" }, "Entitlement": { -"description": " *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. The presence of an Entitlements resource indicates that a user has the right to use a particular app. Entitlements are user specific, not device specific. This allows a user with an entitlement to an app to install the app on all their devices. It's also possible for a user to hold an entitlement to an app without installing the app on any device. The API can be used to create an entitlement. As an option, you can also use the API to trigger the installation of an app on all a user's managed devices at the same time the entitlement is created. If the app is free, creating the entitlement also creates a group license for that app. For paid apps, creating the entitlement consumes one license, and that license remains consumed until the entitlement is removed. If the enterprise hasn't purchased enough licenses, then no entitlement is created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn't accepted. If an entitlement is deleted, the app may be uninstalled from a user's device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement. Entitlements for apps that a user pays for on an unmanaged profile have \"userPurchase\" as the entitlement reason. These entitlements cannot be removed via the API.", +"description": " *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. ", "id": "Entitlement", "properties": { "productId": { @@ -3447,7 +3447,7 @@ "type": "object" }, "GroupLicense": { -"description": " *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. Group license objects allow you to keep track of licenses (called entitlements) for both free and paid apps. For a free app, a group license is created when an enterprise admin first approves the product in Google Play or when the first entitlement for the product is created for a user via the API. For a paid app, a group license object is only created when an enterprise admin purchases the product in Google Play for the first time. Use the API to query group licenses. A Grouplicenses resource includes the total number of licenses purchased (paid apps only) and the total number of licenses currently in use. In other words, the total number of Entitlements that exist for the product. Only one group license object is created per product and group license objects are never deleted. If a product is unapproved, its group license remains. This allows enterprise admins to keep track of any remaining entitlements for the product.", +"description": " *Deprecated:* New integrations cannot use this method and can refer to our new recommendations ", "id": "GroupLicense", "properties": { "acquisitionKind": { @@ -3678,7 +3678,7 @@ "type": "object" }, "ManagedConfiguration": { -"description": " *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user.", +"description": " *Deprecated:* New integrations cannot use this method and can refer to our new recommendations ", "id": "ManagedConfiguration", "properties": { "configurationVariables": { @@ -4582,7 +4582,7 @@ "type": "object" }, "ServiceAccountKey": { -"description": " *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. Credentials that can be used to authenticate as a service account.", +"description": " *Deprecated:* New integrations cannot use this method and can refer to our new recommendations ", "id": "ServiceAccountKey", "properties": { "data": { diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index 339536b9f32..4bbd84389d0 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -1168,7 +1168,7 @@ } } }, -"revision": "20240808", +"revision": "20240821", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -6123,6 +6123,11 @@ false "description": "The carrier name associated with this SIM card.", "type": "string" }, +"iccId": { +"description": "Output only. The ICCID associated with this SIM card.", +"readOnly": true, +"type": "string" +}, "phoneNumber": { "description": "The phone number associated with this SIM card.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json index ba3a56eec58..d17420a7b0e 100644 --- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json +++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json @@ -741,7 +741,8 @@ ], "parameters": { "ackBundleInstallationWarning": { -"description": "Must be set to true if the app bundle installation may trigger a warning on user devices (for example, if installation size may be over a threshold, typically 100 MB).", +"deprecated": true, +"description": "Deprecated. The installation warning has been removed, it's not necessary to set this field anymore.", "location": "query", "type": "boolean" }, @@ -4731,7 +4732,7 @@ } } }, -"revision": "20240814", +"revision": "20240821", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -6226,6 +6227,17 @@ }, "type": "object" }, +"ExternalOfferInitialAcquisitionDetails": { +"description": "Details about the first time a user/device completed a transaction using external offers.", +"id": "ExternalOfferInitialAcquisitionDetails", +"properties": { +"externalTransactionId": { +"description": "Required. The external transaction id of the first completed purchase made by the user.", +"type": "string" +} +}, +"type": "object" +}, "ExternalSubscription": { "description": "Details of an external subscription.", "id": "ExternalSubscription", @@ -6267,6 +6279,10 @@ "description": "Output only. The current tax amount. This represents the current tax amount including any refunds that may have been applied to this transaction.", "readOnly": true }, +"externalOfferInitialAcquisitionDetails": { +"$ref": "ExternalOfferInitialAcquisitionDetails", +"description": "Optional. Details about the first time a user/device completed a transaction using external offers. Not required for transactions made using user choice billing or alternative billing only." +}, "externalTransactionId": { "description": "Output only. The id of this transaction. All transaction ids under the same package name must be unique. Set when creating the external transaction.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json index a1a1529bf6f..814e649f35c 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json @@ -591,7 +591,7 @@ } } }, -"revision": "20240801", +"revision": "20240821", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": { @@ -1281,14 +1281,18 @@ "LOCAL_CONTROLS_BY_S3NS", "SOVEREIGN_CONTROLS_BY_T_SYSTEMS", "SOVEREIGN_CONTROLS_BY_SIA_MINSAIT", -"SOVEREIGN_CONTROLS_BY_PSN" +"SOVEREIGN_CONTROLS_BY_PSN", +"SOVEREIGN_CONTROLS_BY_CNTXT", +"SOVEREIGN_CONTROLS_BY_CNTXT_NO_EKM" ], "enumDescriptions": [ "", "Enum representing S3NS (Thales) partner.", "Enum representing T_SYSTEM (TSI) partner.", "Enum representing SIA_MINSAIT (Indra) partner.", -"Enum representing PSN (TIM) partner." +"Enum representing PSN (TIM) partner.", +"Enum representing CNTXT (Kingdom of Saudi Arabia) partner.", +"Enum representing CNTXT (Kingdom of Saudi Arabia) partner offering without EKM." ], "type": "string" }, @@ -1296,6 +1300,10 @@ "$ref": "GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions", "description": "Optional. Permissions granted to the AW Partner SA account for the customer workload" }, +"partnerServicesBillingAccount": { +"description": "Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC", +"type": "string" +}, "provisionedResourcesParent": { "description": "Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json index 6f1160df442..9d50629febd 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json @@ -588,7 +588,7 @@ } } }, -"revision": "20240801", +"revision": "20240821", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": { @@ -1296,14 +1296,18 @@ "LOCAL_CONTROLS_BY_S3NS", "SOVEREIGN_CONTROLS_BY_T_SYSTEMS", "SOVEREIGN_CONTROLS_BY_SIA_MINSAIT", -"SOVEREIGN_CONTROLS_BY_PSN" +"SOVEREIGN_CONTROLS_BY_PSN", +"SOVEREIGN_CONTROLS_BY_CNTXT", +"SOVEREIGN_CONTROLS_BY_CNTXT_NO_EKM" ], "enumDescriptions": [ "", "Enum representing S3NS (Thales) partner.", "Enum representing T_SYSTEM (TSI) partner.", "Enum representing SIA_MINSAIT (Indra) partner.", -"Enum representing PSN (TIM) partner." +"Enum representing PSN (TIM) partner.", +"Enum representing CNTXT (Kingdom of Saudi Arabia) partner.", +"Enum representing CNTXT (Kingdom of Saudi Arabia) partner offering without EKM." ], "type": "string" }, @@ -1311,6 +1315,10 @@ "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadPartnerPermissions", "description": "Optional. Permissions granted to the AW Partner SA account for the customer workload" }, +"partnerServicesBillingAccount": { +"description": "Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC", +"type": "string" +}, "provisionedResourcesParent": { "description": "Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json index 99f5ee43015..d85fbbf4b36 100644 --- a/googleapiclient/discovery_cache/documents/backupdr.v1.json +++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json @@ -1598,7 +1598,7 @@ } } }, -"revision": "20240808", +"revision": "20240815", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -2486,11 +2486,6 @@ "format": "google-datetime", "type": "string" }, -"enforcedRetentionDuration": { -"description": "Required. The default retention period for each backup in the backup vault (Deprecated).", -"format": "google-duration", -"type": "string" -}, "etag": { "description": "Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/batch.v1.json b/googleapiclient/discovery_cache/documents/batch.v1.json index 4cb6e2badfe..b004595092f 100644 --- a/googleapiclient/discovery_cache/documents/batch.v1.json +++ b/googleapiclient/discovery_cache/documents/batch.v1.json @@ -561,7 +561,7 @@ } } }, -"revision": "20240801", +"revision": "20240813", "rootUrl": "https://batch.googleapis.com/", "schemas": { "Accelerator": { @@ -1256,6 +1256,10 @@ "description": "InstancePolicyOrTemplate lets you define the type of resources to use for this job either with an InstancePolicy or an instance template. If undefined, Batch picks the type of VM to use and doesn't include optional VM resources such as GPUs and extra disks.", "id": "InstancePolicyOrTemplate", "properties": { +"blockProjectSshKeys": { +"description": "Optional. Set this field to `true` if you want Batch to block project-level SSH keys from accessing this job's VMs. Alternatively, you can configure the job to specify a VM instance template that blocks project-level SSH keys. In either case, Batch blocks project-level SSH keys while creating the VMs for this job. Batch allows project-level SSH keys for a job's VMs only if all the following are true: + This field is undefined or set to `false`. + The job's VM instance template (if any) doesn't block project-level SSH keys. Notably, you can override this behavior by manually updating a VM to block or allow project-level SSH keys. For more information about blocking project-level SSH keys, see the Compute Engine documentation: https://cloud.google.com/compute/docs/connect/restrict-ssh-keys#block-keys", +"type": "boolean" +}, "installGpuDrivers": { "description": "Set this field true if you want Batch to help fetch drivers from a third party location and install them for GPUs specified in `policy.accelerators` or `instance_template` on your behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index abb0e60806a..3b34232dc11 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -1935,7 +1935,7 @@ } } }, -"revision": "20240803", +"revision": "20240815", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -4810,7 +4810,7 @@ }, "jobCreationReason": { "$ref": "JobCreationReason", -"description": "Output only. If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.", +"description": "Output only. The reason why a Job was created. [Preview](/products/#product-launch-stages)", "readOnly": true }, "jobReference": { @@ -5370,7 +5370,7 @@ "type": "object" }, "JobCreationReason": { -"description": "Reason about why a Job was created from a [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`. This feature is not yet available. Jobs will always be created.", +"description": "Reason about why a Job was created from a [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`. [Preview](/products/#product-launch-stages)", "id": "JobCreationReason", "properties": { "code": { @@ -7109,7 +7109,7 @@ "description": "Optional. Output format adjustments." }, "jobCreationMode": { -"description": "Optional. If not set, jobs are always required. If set, the query request will follow the behavior described JobCreationMode. This feature is not yet available. Jobs will always be created.", +"description": "Optional. If not set, jobs are always required. If set, the query request will follow the behavior described JobCreationMode. [Preview](/products/#product-launch-stages)", "enum": [ "JOB_CREATION_MODE_UNSPECIFIED", "JOB_CREATION_REQUIRED", @@ -7216,11 +7216,11 @@ }, "jobCreationReason": { "$ref": "JobCreationReason", -"description": "Optional. Only relevant when a job_reference is present in the response. If job_reference is not present it will always be unset. When job_reference is present, this field should be interpreted as follows: If set, it will provide the reason of why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created." +"description": "Optional. The reason why a Job was created. Only relevant when a job_reference is present in the response. If job_reference is not present it will always be unset. [Preview](/products/#product-launch-stages)" }, "jobReference": { "$ref": "JobReference", -"description": "Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults)." +"description": "Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults). If job_creation_mode was set to `JOB_CREATION_OPTIONAL` and the query completes without creating a job, this field will be empty." }, "kind": { "default": "bigquery#queryResponse", @@ -7238,7 +7238,7 @@ "type": "string" }, "queryId": { -"description": "Query ID for the completed query. This ID will be auto-generated. This field is not yet available and it is currently not guaranteed to be populated.", +"description": "Auto-generated ID for the query. [Preview](/products/#product-launch-stages)", "type": "string" }, "rows": { @@ -8152,7 +8152,7 @@ "type": "object" }, "StandardSqlDataType": { -"description": "The data type of a variable such as a function argument. Examples include: * INT64: `{\"typeKind\": \"INT64\"}` * ARRAY: { \"typeKind\": \"ARRAY\", \"arrayElementType\": {\"typeKind\": \"STRING\"} } * STRUCT>: { \"typeKind\": \"STRUCT\", \"structType\": { \"fields\": [ { \"name\": \"x\", \"type\": {\"typeKind\": \"STRING\"} }, { \"name\": \"y\", \"type\": { \"typeKind\": \"ARRAY\", \"arrayElementType\": {\"typeKind\": \"DATE\"} } } ] } }", +"description": "The data type of a variable such as a function argument. Examples include: * INT64: `{\"typeKind\": \"INT64\"}` * ARRAY: { \"typeKind\": \"ARRAY\", \"arrayElementType\": {\"typeKind\": \"STRING\"} } * STRUCT>: { \"typeKind\": \"STRUCT\", \"structType\": { \"fields\": [ { \"name\": \"x\", \"type\": {\"typeKind\": \"STRING\"} }, { \"name\": \"y\", \"type\": { \"typeKind\": \"ARRAY\", \"arrayElementType\": {\"typeKind\": \"DATE\"} } } ] } } * RANGE: { \"typeKind\": \"RANGE\", \"rangeElementType\": {\"typeKind\": \"DATE\"} }", "id": "StandardSqlDataType", "properties": { "arrayElementType": { @@ -8908,7 +8908,7 @@ "type": "string" }, "type": { -"description": "Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema.", +"description": "Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index 77fc6e1ee94..4548f1141db 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -318,6 +318,11 @@ "pattern": "^spaces/[^/]+$", "required": true, "type": "string" +}, +"useAdminAccess": { +"description": "[Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.delete` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}", @@ -368,6 +373,11 @@ "pattern": "^spaces/[^/]+$", "required": true, "type": "string" +}, +"useAdminAccess": { +"description": "[Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` or `chat.admin.spaces.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}", @@ -437,6 +447,11 @@ "format": "google-fieldmask", "location": "query", "type": "string" +}, +"useAdminAccess": { +"description": "[Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Some `FieldMask` values are not supported using admin access. For details, see the description of `update_mask`.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}", @@ -452,6 +467,49 @@ "https://www.googleapis.com/auth/chat.spaces" ] }, +"search": { +"description": "[Developer Preview](https://developers.google.com/workspace/preview). Returns a list of spaces based on a user's search. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). The user must be an administrator for the Google Workspace organization. In the request, set `use_admin_access` to `true`.", +"flatPath": "v1/spaces:search", +"httpMethod": "GET", +"id": "chat.spaces.search", +"parameterOrder": [], +"parameters": { +"orderBy": { +"description": "Optional. How the list of spaces is ordered. Supported attributes to order by are: - `membership_count.joined_direct_human_user_count` \u2014 Denotes the count of human users that have directly joined a space. - `last_active_time` \u2014 Denotes the time when last eligible item is added to any topic of this space. - `create_time` \u2014 Denotes the time of the space creation. Valid ordering operation values are: - `ASC` for ascending. Default value. - `DESC` for descending. The supported syntax are: - `membership_count.joined_direct_human_user_count DESC` - `membership_count.joined_direct_human_user_count ASC` - `last_active_time DESC` - `last_active_time ASC` - `create_time DESC` - `create_time ASC`", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of spaces to return. The service may return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token, received from the previous search spaces call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.", +"location": "query", +"type": "string" +}, +"query": { +"description": "Required. A search query. You can search by using the following parameters: - `create_time` - `customer` - `display_name` - `external_user_allowed` - `last_active_time` - `space_history_state` - `space_type` `create_time` and `last_active_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `=`, `<`, `>`, `<=`, `>=`. `customer` is required and is used to indicate which customer to fetch spaces from. `customers/my_customer` is the only supported value. `display_name` only accepts the `HAS` (`:`) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's `display_name`. For example, `Fun Eve` matches `Fun event` or `The evening was fun`, but not `notFun event` or `even`. `external_user_allowed` accepts either `true` or `false`. `space_history_state` only accepts values from the [`historyState`] (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState) field of a `space` resource. `space_type` is required and the only valid value is `SPACE`. Across different fields, only `AND` operators are supported. A valid example is `space_type = \"SPACE\" AND display_name:\"Hello\"` and an invalid example is `space_type = \"SPACE\" OR display_name:\"Hello\"`. Among the same field, `space_type` doesn't support `AND` or `OR` operators. `display_name`, 'space_history_state', and 'external_user_allowed' only support `OR` operators. `last_active_time` and `create_time` support both `AND` and `OR` operators. `AND` can only be used to represent an interval, such as `last_active_time < \"2022-01-01T00:00:00+00:00\" AND last_active_time > \"2023-01-01T00:00:00+00:00\"`. The following example queries are valid: ``` customer = \"customers/my_customer\" AND space_type = \"SPACE\" customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND display_name:\"Hello World\" customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (last_active_time < \"2020-01-01T00:00:00+00:00\" OR last_active_time > \"2022-01-01T00:00:00+00:00\") customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (display_name:\"Hello World\" OR display_name:\"Fun event\") AND (last_active_time > \"2020-01-01T00:00:00+00:00\" AND last_active_time < \"2022-01-01T00:00:00+00:00\") customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (create_time > \"2019-01-01T00:00:00+00:00\" AND create_time < \"2020-01-01T00:00:00+00:00\") AND (external_user_allowed = \"true\") AND (space_history_state = \"HISTORY_ON\" OR space_history_state = \"HISTORY_OFF\") ```", +"location": "query", +"type": "string" +}, +"useAdminAccess": { +"description": "When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.spaces.readonly` or `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). This method currently only supports admin access, thus only `true` is accepted for this field.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/spaces:search", +"response": { +"$ref": "SearchSpacesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/chat.admin.spaces", +"https://www.googleapis.com/auth/chat.admin.spaces.readonly" +] +}, "setup": { "description": "Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see [Set up a space with initial members](https://developers.google.com/workspace/chat/set-up-spaces). To specify the human members to add, add memberships with the appropriate `membership.member.name`. To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. To specify the Google groups to add, add memberships with the appropriate `membership.group_member.name`. To add or invite a Google group, use `groups/{group}`, where `{group}` is the `id` for the group from the Cloud Identity Groups API. For example, you can use [Cloud Identity Groups lookup API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup) to retrieve the ID `123456789` for group email `group@example.com`, then you can add the group to the space by setting the `membership.group_member.name` to `groups/123456789`. Group email is not supported, and Google groups can only be added as members in named spaces. For a named space or group chat, if the caller blocks, or is blocked by some members, or doesn't have permission to add some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to `true` and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see [Invite or add a user or app to a space](https://developers.google.com/workspace/chat/create-members). If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", "flatPath": "v1/spaces:setup", @@ -476,7 +534,7 @@ "members": { "methods": { "create": { -"description": "Creates a human membership or app membership for the calling app. Creating memberships for other apps isn't supported. For an example, see [Invite or add a user or a Google Chat app to a space](https://developers.google.com/workspace/chat/create-members). When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). To specify the member to add, set the `membership.member.name` for the human or app member, or set the `membership.group_member.name` for the group member. - To add the calling app to a space or a direct message between two human users, use `users/app`. Unable to add other apps to the space. - To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. - To add or invite a Google group in a named space, use `groups/{group}`, where `{group}` is the `id` for the group from the Cloud Identity Groups API. For example, you can use [Cloud Identity Groups lookup API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup) to retrieve the ID `123456789` for group email `group@example.com`, then you can add or invite the group to a named space by setting the `membership.group_member.name` to `groups/123456789`. Group email is not supported, and Google groups can only be added as members in named spaces.", +"description": "Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). For example usage, see: - [Invite or add a user to a space](https://developers.google.com/workspace/chat/create-members#create-user-membership). - [Invite or add a Google Group to a space](https://developers.google.com/workspace/chat/create-members#create-group-membership). - [Add the Chat app to a space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api).", "flatPath": "v1/spaces/{spacesId}/members", "httpMethod": "POST", "id": "chat.spaces.members.create", @@ -490,6 +548,11 @@ "pattern": "^spaces/[^/]+$", "required": true, "type": "string" +}, +"useAdminAccess": { +"description": "[Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+parent}/members", @@ -521,6 +584,11 @@ "pattern": "^spaces/[^/]+/members/[^/]+$", "required": true, "type": "string" +}, +"useAdminAccess": { +"description": "[Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Deleting app memberships in a space isn't supported using admin access.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}", @@ -549,6 +617,11 @@ "pattern": "^spaces/[^/]+/members/[^/]+$", "required": true, "type": "string" +}, +"useAdminAccess": { +"description": "[Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` or `chat.admin.memberships.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Getting app memberships in a space isn't supported when using admin access.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}", @@ -604,6 +677,11 @@ "description": "Optional. When `true`, also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited memberships that don't match the filter criteria aren't returned. Currently requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", "location": "query", "type": "boolean" +}, +"useAdminAccess": { +"description": "[Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.memberships.readonly` or `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Listing app memberships in a space isn't supported when using admin access.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+parent}/members", @@ -640,6 +718,11 @@ "format": "google-fieldmask", "location": "query", "type": "string" +}, +"useAdminAccess": { +"description": "[Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}", @@ -781,7 +864,7 @@ ] }, "list": { -"description": "Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. For an example, see [List messages](/chat/api/guides/v1/messages/list). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", +"description": "Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, `{}`. For an example, see [List messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", "flatPath": "v1/spaces/{spacesId}/messages", "httpMethod": "GET", "id": "chat.spaces.messages.list", @@ -1241,7 +1324,7 @@ } } }, -"revision": "20240813", +"revision": "20240818", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -2754,7 +2837,7 @@ }, "hostAppDataSource": { "$ref": "HostAppDataSourceMarkup", -"description": "A data source that's unique to a Google Workspace host application, such spaces in Google Chat." +"description": "A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries)." } }, "type": "object" @@ -3571,6 +3654,23 @@ }, "type": "object" }, +"MembershipCount": { +"description": "[Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories.", +"id": "MembershipCount", +"properties": { +"joinedDirectHumanUserCount": { +"description": "Count of human users that have directly joined the space, not counting users joined by having membership in a joined group.", +"format": "int32", +"type": "integer" +}, +"joinedGroupCount": { +"description": "Count of all groups that have directly joined the space.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "MembershipCreatedEventData": { "description": "Event payload for a new membership. Event type: `google.workspace.chat.membership.v1.created`.", "id": "MembershipCreatedEventData", @@ -3969,6 +4069,29 @@ }, "type": "object" }, +"SearchSpacesResponse": { +"description": "Response with a list of spaces corresponding to the search spaces request.", +"id": "SearchSpacesResponse", +"properties": { +"nextPageToken": { +"description": "A token that can be used to retrieve the next page. If this field is empty, there are no subsequent pages.", +"type": "string" +}, +"spaces": { +"description": "A page of the requested spaces.", +"items": { +"$ref": "Space" +}, +"type": "array" +}, +"totalSize": { +"description": "The total number of spaces that match the query, across all pages. If the result is over 10,000 spaces, this value is an estimate.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "Section": { "description": "A section contains a collection of widgets that are rendered (vertically) in the order that they are specified. Across all platforms, cards have a narrow fixed width, so there's currently no need for layout properties (for example, float).", "id": "Section", @@ -4103,6 +4226,17 @@ "description": "Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete.", "type": "boolean" }, +"lastActiveTime": { +"description": "Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview).", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"membershipCount": { +"$ref": "MembershipCount", +"description": "Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview).", +"readOnly": true +}, "name": { "description": "Resource name of the space. Format: `spaces/{space}`", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1.json index 2a0c9c80f7a..b61ac80314f 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1.json @@ -358,6 +358,59 @@ }, "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`.", +"flatPath": "v1/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "cloudasset.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^operations/.*$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"request": { +"$ref": "CancelOperationRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "cloudasset.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^operations/.*$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1/{v1Id}/{v1Id1}/operations/{operationsId}/{operationsId1}", @@ -1095,7 +1148,7 @@ } } }, -"revision": "20240803", +"revision": "20240816", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { @@ -1371,6 +1424,17 @@ }, "type": "object" }, +"AssetEnrichment": { +"description": "The enhanced metadata information for a resource.", +"id": "AssetEnrichment", +"properties": { +"resourceOwners": { +"$ref": "ResourceOwners", +"description": "The resource owners for a resource. Note that this field only contains the members that have \"roles/owner\" role in the resource's IAM Policy." +} +}, +"type": "object" +}, "AttachedResource": { "description": "Attached resource representation, which is defined by the corresponding service provider. It represents an attached resource's payload.", "id": "AttachedResource", @@ -1514,6 +1578,12 @@ }, "type": "object" }, +"CancelOperationRequest": { +"description": "The request message for Operations.CancelOperation.", +"id": "CancelOperationRequest", +"properties": {}, +"type": "object" +}, "ConditionContext": { "description": "The IAM conditions context.", "id": "ConditionContext", @@ -4075,6 +4145,20 @@ }, "type": "object" }, +"ResourceOwners": { +"description": "The resource owners information.", +"id": "ResourceOwners", +"properties": { +"resourceOwners": { +"description": "List of resource owners.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ResourceSearchResult": { "description": "A result of Resource Search, containing information of a cloud resource.", "id": "ResourceSearchResult", @@ -4118,6 +4202,13 @@ }, "type": "array" }, +"enrichments": { +"description": "Enrichments of the asset.", +"items": { +"$ref": "AssetEnrichment" +}, +"type": "array" +}, "folders": { "description": "The folder(s) that this resource belongs to, in the form of folders/{FOLDER_NUMBER}. This field is available when the resource belongs to one or more folders. To search against `folders`: * Use a field query. Example: `folders:(123 OR 456)` * Use a free text query. Example: `123` * Specify the `scope` field as this folder in your search request.", "items": { diff --git a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json index 3ad8e863e06..130878c483c 100644 --- a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json @@ -484,7 +484,7 @@ } } }, -"revision": "20240731", +"revision": "20240814", "rootUrl": "https://cloudcontrolspartner.googleapis.com/", "schemas": { "AccessApprovalRequest": { @@ -598,7 +598,7 @@ "readOnly": true }, "displayName": { -"description": "Optional. The customer organization's display name. E.g. \"Google\".", +"description": "The customer organization's display name. E.g. \"Google\".", "type": "string" }, "isOnboarded": { diff --git a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json index 523b45b788a..58c4320d297 100644 --- a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json +++ b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json @@ -484,7 +484,7 @@ } } }, -"revision": "20240731", +"revision": "20240814", "rootUrl": "https://cloudcontrolspartner.googleapis.com/", "schemas": { "AccessApprovalRequest": { @@ -598,7 +598,7 @@ "readOnly": true }, "displayName": { -"description": "Optional. The customer organization's display name. E.g. \"Google\".", +"description": "The customer organization's display name. E.g. \"Google\".", "type": "string" }, "isOnboarded": { diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json index 797b0c976cc..d51fa71444e 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json @@ -422,7 +422,7 @@ ], "enumDescriptions": [ "Default value. The value is unused.", -"This view contains all devices imported by the company admin. Each device in the response contains all information specified by the company admin when importing the device (i.e. asset tags). This includes devices that may be unaassigned or assigned to users.", +"This view contains all devices imported by the company admin. Each device in the response contains all information specified by the company admin when importing the device (i.e. asset tags). This includes devices that may be unassigned or assigned to users.", "This view contains all devices with at least one user registered on the device. Each device in the response contains all device information, except for asset tags." ], "location": "query", @@ -1990,7 +1990,7 @@ } } }, -"revision": "20240702", +"revision": "20240820", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudkms.v1.json b/googleapiclient/discovery_cache/documents/cloudkms.v1.json index c599682faaf..f20aa29b404 100644 --- a/googleapiclient/discovery_cache/documents/cloudkms.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudkms.v1.json @@ -859,6 +859,17 @@ "location": "query", "type": "string" }, +"pageSize": { +"description": "Optional. Optional limit on the number of KeyHandles to include in the response. The service may return fewer than this value. Further KeyHandles can subsequently be obtained by including the ListKeyHandlesResponse.next_page_token in a subsequent request. If unspecified, at most KeyHandles 100 will be returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Optional pagination token, returned earlier via ListKeyHandlesResponse.next_page_token.", +"location": "query", +"type": "string" +}, "parent": { "description": "Required. Name of the resource project and location from which to list KeyHandles, e.g. `projects/{PROJECT_ID}/locations/{LOCATION}`.", "location": "path", @@ -2101,7 +2112,7 @@ } } }, -"revision": "20240801", +"revision": "20240808", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AsymmetricDecryptRequest": { @@ -2292,6 +2303,23 @@ "name": { "description": "Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`.", "type": "string" +}, +"state": { +"description": "Output only. The state for the AutokeyConfig.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"KEY_PROJECT_DELETED", +"UNINITIALIZED" +], +"enumDescriptions": [ +"The state of the AutokeyConfig is unspecified.", +"The AutokeyConfig is currently active.", +"A previously configured key project has been deleted and the current AutokeyConfig is unusable.", +"The AutokeyConfig is not yet initialized or has been reset to its default uninitialized state." +], +"readOnly": true, +"type": "string" } }, "type": "object" @@ -2943,7 +2971,7 @@ "type": "string" }, "serviceResolvers": { -"description": "A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.", +"description": "Optional. A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.", "items": { "$ref": "ServiceResolver" }, @@ -3534,6 +3562,10 @@ "$ref": "KeyHandle" }, "type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve next page of results. Pass this value in ListKeyHandlesRequest.page_token to retrieve the next page of results.", +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/cloudtrace.v1.json b/googleapiclient/discovery_cache/documents/cloudtrace.v1.json index 3f4fe116d58..594fc0c7ead 100644 --- a/googleapiclient/discovery_cache/documents/cloudtrace.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudtrace.v1.json @@ -257,7 +257,7 @@ } } }, -"revision": "20240621", +"revision": "20240816", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Empty": { @@ -333,7 +333,7 @@ "additionalProperties": { "type": "string" }, -"description": "Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 kilobytes (10MB for `/stacktrace` values). Some predefined label keys exist, or you may create your own. When creating your own, we recommend the following formats: * `/category/product/key` for agents of well-known products (e.g. `/db/mongodb/read_size`). * `short_host/path/key` for domain-specific keys (e.g. `foo.com/myproduct/bar`) Predefined labels include: * `/agent` * `/component` * `/error/message` * `/error/name` * `/http/client_city` * `/http/client_country` * `/http/client_protocol` * `/http/client_region` * `/http/host` * `/http/method` * `/http/path` * `/http/redirected_url` * `/http/request/size` * `/http/response/size` * `/http/route` * `/http/status_code` * `/http/url` * `/http/user_agent` * `/pid` * `/stacktrace` * `/tid`", +"description": "Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 KiB. Some keys might have predefined meaning, and you can also create your own. For more information, see [Cloud Trace labels](https://cloud.google.com/trace/docs/trace-labels).", "type": "object" }, "name": { diff --git a/googleapiclient/discovery_cache/documents/connectors.v1.json b/googleapiclient/discovery_cache/documents/connectors.v1.json index 010928f96bb..20d9b170894 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v1.json +++ b/googleapiclient/discovery_cache/documents/connectors.v1.json @@ -1320,6 +1320,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+/endpointAttachments/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "Optional. Specifies which fields of the EndpointAttachment are returned in the response. Defaults to `ENDPOINT_ATTACHMENT_VIEW_BASIC` view.", +"enum": [ +"ENDPOINT_ATTACHMENT_VIEW_UNSPECIFIED", +"ENDPOINT_ATTACHMENT_VIEW_BASIC", +"ENDPOINT_ATTACHMENT_VIEW_FULL" +], +"enumDescriptions": [ +"ENDPOINT_ATTACHMENT_VIEW_UNSPECIFIED.", +"Do not include status.", +"Includes Status." +], +"location": "query", +"type": "string" } }, "path": "v1/{+name}", @@ -1366,6 +1381,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "Optional. Specifies which fields of the EndpointAttachment are returned in the response. Defaults to `ENDPOINT_ATTACHMENT_VIEW_BASIC` view.", +"enum": [ +"ENDPOINT_ATTACHMENT_VIEW_UNSPECIFIED", +"ENDPOINT_ATTACHMENT_VIEW_BASIC", +"ENDPOINT_ATTACHMENT_VIEW_FULL" +], +"enumDescriptions": [ +"ENDPOINT_ATTACHMENT_VIEW_UNSPECIFIED.", +"Do not include status.", +"Includes Status." +], +"location": "query", +"type": "string" } }, "path": "v1/{+parent}/endpointAttachments", @@ -2427,7 +2457,7 @@ } } }, -"revision": "20240811", +"revision": "20240822", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -4058,6 +4088,31 @@ "description": "Required. The path of the service attachment", "type": "string" }, +"state": { +"description": "Output only. The Private Service Connect Connection Endpoint State. This value is only available in the Full view.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING", +"ACCEPTED", +"REJECTED", +"CLOSED", +"FROZEN", +"NEEDS_ATTENTION", +"ACCEPTED_NOT_PROGRAMMED" +], +"enumDescriptions": [ +"STATE_UNSPECIFIED.", +"The endpoint is pending acceptance by the producer.", +"The endpoint has been accepted by the producer.", +"The endpoint has been rejected by the producer.", +"The endpoint has been closed by the producer and will not serve traffic going forward.", +"The endpoint has been frozen by the producer and will not serve traffic.", +"The endpoint has been accepted by the producer, but it is not ready to serve the traffic due to producer side issues.", +"The endpoint has been accepted by the producer, but it cannot be programmed to the data plane due to invariant violation." +], +"readOnly": true, +"type": "string" +}, "updateTime": { "description": "Output only. Updated time.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index b18e6dac370..c6faba864f2 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -2540,7 +2540,7 @@ } } }, -"revision": "20240730", +"revision": "20240806", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3369,6 +3369,10 @@ "$ref": "PrivateClusterConfig", "description": "Configuration for private cluster." }, +"rbacBindingConfig": { +"$ref": "RBACBindingConfig", +"description": "RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created." +}, "releaseChannel": { "$ref": "ReleaseChannel", "description": "Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version." @@ -3756,6 +3760,10 @@ ], "type": "string" }, +"desiredRbacBindingConfig": { +"$ref": "RBACBindingConfig", +"description": "RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created." +}, "desiredReleaseChannel": { "$ref": "ReleaseChannel", "description": "The desired release channel configuration." @@ -4960,7 +4968,7 @@ false "id": "MasterAuth", "properties": { "clientCertificate": { -"description": "Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.", +"description": "Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set.", "readOnly": true, "type": "string" }, @@ -6316,6 +6324,21 @@ false }, "type": "object" }, +"RBACBindingConfig": { +"description": "RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.", +"id": "RBACBindingConfig", +"properties": { +"enableInsecureBindingSystemAuthenticated": { +"description": "Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated.", +"type": "boolean" +}, +"enableInsecureBindingSystemUnauthenticated": { +"description": "Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated.", +"type": "boolean" +} +}, +"type": "object" +}, "RangeInfo": { "description": "RangeInfo contains the range name and the range utilization by this cluster.", "id": "RangeInfo", diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index 350ed9f0b53..24ade17c9e0 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -2565,7 +2565,7 @@ } } }, -"revision": "20240730", +"revision": "20240806", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3505,6 +3505,10 @@ "deprecated": true, "description": "Deprecated: Use SecurityPostureConfig instead. Enable/Disable Protect API features for the cluster." }, +"rbacBindingConfig": { +"$ref": "RBACBindingConfig", +"description": "RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created." +}, "releaseChannel": { "$ref": "ReleaseChannel", "description": "Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version." @@ -3948,6 +3952,10 @@ "deprecated": true, "description": "Deprecated: Use DesiredSecurityPostureConfig instead. Enable/Disable Protect API features for the cluster." }, +"desiredRbacBindingConfig": { +"$ref": "RBACBindingConfig", +"description": "RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created." +}, "desiredReleaseChannel": { "$ref": "ReleaseChannel", "description": "The desired release channel configuration." @@ -5361,7 +5369,7 @@ false "id": "MasterAuth", "properties": { "clientCertificate": { -"description": "Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.", +"description": "Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set.", "readOnly": true, "type": "string" }, @@ -6829,6 +6837,21 @@ false }, "type": "object" }, +"RBACBindingConfig": { +"description": "RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.", +"id": "RBACBindingConfig", +"properties": { +"enableInsecureBindingSystemAuthenticated": { +"description": "Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated.", +"type": "boolean" +}, +"enableInsecureBindingSystemUnauthenticated": { +"description": "Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated.", +"type": "boolean" +} +}, +"type": "object" +}, "RangeInfo": { "description": "RangeInfo contains the range name and the range utilization by this cluster.", "id": "RangeInfo", diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json index ee58a35071d..ba596a31347 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json @@ -18,8 +18,188 @@ "endpoints": [ { "description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://containeranalysis.me-central2.rep.googleapis.com/", "location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-central2.rep.googleapis.com/", +"location": "us-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-west4.rep.googleapis.com/", +"location": "us-west4" } ], "fullyEncodeReservedExpansion": true, @@ -229,6 +409,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:getIamPolicy", +"httpMethod": "POST", +"id": "containeranalysis.projects.locations.notes.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/notes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"request": { +"$ref": "GetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists notes for the specified project.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notes", @@ -303,6 +511,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:setIamPolicy", +"httpMethod": "POST", +"id": "containeranalysis.projects.locations.notes.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/notes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:testIamPermissions", +"httpMethod": "POST", +"id": "containeranalysis.projects.locations.notes.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/notes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -461,6 +725,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:getIamPolicy", +"httpMethod": "POST", +"id": "containeranalysis.projects.locations.occurrences.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/occurrences/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"request": { +"$ref": "GetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "getNotes": { "description": "Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}/notes", @@ -590,6 +882,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:setIamPolicy", +"httpMethod": "POST", +"id": "containeranalysis.projects.locations.occurrences.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/occurrences/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:testIamPermissions", +"httpMethod": "POST", +"id": "containeranalysis.projects.locations.occurrences.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/occurrences/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -1307,7 +1655,7 @@ } } }, -"revision": "20240726", +"revision": "20240816", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json index 2e7db929dfe..d28132e8fbe 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json @@ -18,8 +18,188 @@ "endpoints": [ { "description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://containeranalysis.me-central2.rep.googleapis.com/", "location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-central2.rep.googleapis.com/", +"location": "us-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-west4.rep.googleapis.com/", +"location": "us-west4" } ], "fullyEncodeReservedExpansion": true, @@ -1240,7 +1420,7 @@ } } }, -"revision": "20240704", +"revision": "20240816", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AnalysisCompleted": { diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json index 5aa2d0732c4..53f3e01cf93 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json @@ -18,8 +18,188 @@ "endpoints": [ { "description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://containeranalysis.me-central2.rep.googleapis.com/", "location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-central2.rep.googleapis.com/", +"location": "us-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://containeranalysis.us-west4.rep.googleapis.com/", +"location": "us-west4" } ], "fullyEncodeReservedExpansion": true, @@ -1363,7 +1543,7 @@ } } }, -"revision": "20240726", +"revision": "20240816", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { diff --git a/googleapiclient/discovery_cache/documents/customsearch.v1.json b/googleapiclient/discovery_cache/documents/customsearch.v1.json index 9814acec944..632a76202fc 100644 --- a/googleapiclient/discovery_cache/documents/customsearch.v1.json +++ b/googleapiclient/discovery_cache/documents/customsearch.v1.json @@ -124,6 +124,11 @@ "location": "query", "type": "string" }, +"enableAlternateSearchHandler": { +"description": "Optional. Enables routing of Programmable Search Engine requests to an alternate search handler.", +"location": "query", +"type": "boolean" +}, "exactTerms": { "description": "Identifies a phrase that all documents in the search results must contain.", "location": "query", @@ -426,6 +431,11 @@ false "location": "query", "type": "string" }, +"enableAlternateSearchHandler": { +"description": "Optional. Enables routing of Programmable Search Engine requests to an alternate search handler.", +"location": "query", +"type": "boolean" +}, "exactTerms": { "description": "Identifies a phrase that all documents in the search results must contain.", "location": "query", @@ -702,7 +712,7 @@ false } } }, -"revision": "20240704", +"revision": "20240821", "rootUrl": "https://customsearch.googleapis.com/", "schemas": { "Promotion": { diff --git a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json index 2ec817ed1b4..c1312078034 100644 --- a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json +++ b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json @@ -2208,7 +2208,7 @@ } } }, -"revision": "20240807", +"revision": "20240817", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -6761,6 +6761,16 @@ false "description": "Map from user step names to state families.", "type": "object" }, +"userWorkerRunnerV1Settings": { +"description": "Binary encoded proto to control runtime behavior of the java runner v1 user worker.", +"format": "byte", +"type": "string" +}, +"userWorkerRunnerV2Settings": { +"description": "Binary encoded proto to control runtime behavior of the runner v2 user worker.", +"format": "byte", +"type": "string" +}, "windmillServiceEndpoint": { "description": "If present, the worker must use this endpoint to communicate with Windmill Service dispatchers, otherwise the worker must continue to use whatever endpoint it had been using.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json index faf3e9cce0b..16ca09ea9cd 100644 --- a/googleapiclient/discovery_cache/documents/dataplex.v1.json +++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json @@ -199,6 +199,129 @@ ] } } +}, +"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.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "dataplex.organizations.locations.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"request": { +"$ref": "GoogleLongrunningCancelOperationRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "dataplex.organizations.locations.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "dataplex.organizations.locations.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"listOperations": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "dataplex.organizations.locations.operations.listOperations", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} } } } @@ -2396,6 +2519,97 @@ } } }, +"entryLinkTypes": { +"methods": { +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryLinkTypes/{entryLinkTypesId}:getIamPolicy", +"httpMethod": "GET", +"id": "dataplex.projects.locations.entryLinkTypes.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/entryLinkTypes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryLinkTypes/{entryLinkTypesId}:setIamPolicy", +"httpMethod": "POST", +"id": "dataplex.projects.locations.entryLinkTypes.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/entryLinkTypes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "GoogleIamV1SetIamPolicyRequest" +}, +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryLinkTypes/{entryLinkTypesId}:testIamPermissions", +"httpMethod": "POST", +"id": "dataplex.projects.locations.entryLinkTypes.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/entryLinkTypes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "GoogleIamV1TestIamPermissionsRequest" +}, +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "entryTypes": { "methods": { "create": { @@ -2568,40 +2782,222 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"patch": { -"description": "Updates an EntryType.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}", -"httpMethod": "PATCH", -"id": "dataplex.projects.locations.entryTypes.patch", +"patch": { +"description": "Updates an EntryType.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}", +"httpMethod": "PATCH", +"id": "dataplex.projects.locations.entryTypes.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Output only. The relative resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/entryTypes/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Mask of fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "Optional. The service validates the request without performing any mutations. The default is false.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudDataplexV1EntryType" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:setIamPolicy", +"httpMethod": "POST", +"id": "dataplex.projects.locations.entryTypes.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/entryTypes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "GoogleIamV1SetIamPolicyRequest" +}, +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:testIamPermissions", +"httpMethod": "POST", +"id": "dataplex.projects.locations.entryTypes.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/entryTypes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "GoogleIamV1TestIamPermissionsRequest" +}, +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"glossaries": { +"methods": { +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:getIamPolicy", +"httpMethod": "GET", +"id": "dataplex.projects.locations.glossaries.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:setIamPolicy", +"httpMethod": "POST", +"id": "dataplex.projects.locations.glossaries.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "GoogleIamV1SetIamPolicyRequest" +}, +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:testIamPermissions", +"httpMethod": "POST", +"id": "dataplex.projects.locations.glossaries.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "GoogleIamV1TestIamPermissionsRequest" +}, +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"categories": { +"methods": { +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}:getIamPolicy", +"httpMethod": "GET", +"id": "dataplex.projects.locations.glossaries.categories.getIamPolicy", "parameterOrder": [ -"name" +"resource" ], "parameters": { -"name": { -"description": "Output only. The relative resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.", +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/entryTypes/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/categories/[^/]+$", "required": true, "type": "string" -}, -"updateMask": { -"description": "Required. Mask of fields to update.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -}, -"validateOnly": { -"description": "Optional. The service validates the request without performing any mutations. The default is false.", -"location": "query", -"type": "boolean" } }, -"path": "v1/{+name}", -"request": { -"$ref": "GoogleCloudDataplexV1EntryType" -}, +"path": "v1/{+resource}:getIamPolicy", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -2609,9 +3005,9 @@ }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:setIamPolicy", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}:setIamPolicy", "httpMethod": "POST", -"id": "dataplex.projects.locations.entryTypes.setIamPolicy", +"id": "dataplex.projects.locations.glossaries.categories.setIamPolicy", "parameterOrder": [ "resource" ], @@ -2619,7 +3015,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/entryTypes/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/categories/[^/]+$", "required": true, "type": "string" } @@ -2637,9 +3033,9 @@ }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:testIamPermissions", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}:testIamPermissions", "httpMethod": "POST", -"id": "dataplex.projects.locations.entryTypes.testIamPermissions", +"id": "dataplex.projects.locations.glossaries.categories.testIamPermissions", "parameterOrder": [ "resource" ], @@ -2647,7 +3043,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/entryTypes/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/categories/[^/]+$", "required": true, "type": "string" } @@ -2665,13 +3061,13 @@ } } }, -"glossaries": { +"terms": { "methods": { "getIamPolicy": { "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:getIamPolicy", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}:getIamPolicy", "httpMethod": "GET", -"id": "dataplex.projects.locations.glossaries.getIamPolicy", +"id": "dataplex.projects.locations.glossaries.terms.getIamPolicy", "parameterOrder": [ "resource" ], @@ -2685,7 +3081,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/terms/[^/]+$", "required": true, "type": "string" } @@ -2700,9 +3096,9 @@ }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:setIamPolicy", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}:setIamPolicy", "httpMethod": "POST", -"id": "dataplex.projects.locations.glossaries.setIamPolicy", +"id": "dataplex.projects.locations.glossaries.terms.setIamPolicy", "parameterOrder": [ "resource" ], @@ -2710,7 +3106,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/terms/[^/]+$", "required": true, "type": "string" } @@ -2728,9 +3124,9 @@ }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:testIamPermissions", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}:testIamPermissions", "httpMethod": "POST", -"id": "dataplex.projects.locations.glossaries.testIamPermissions", +"id": "dataplex.projects.locations.glossaries.terms.testIamPermissions", "parameterOrder": [ "resource" ], @@ -2738,7 +3134,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/terms/[^/]+$", "required": true, "type": "string" } @@ -2755,6 +3151,8 @@ ] } } +} +} }, "governanceRules": { "methods": { @@ -5599,9 +5997,397 @@ } } }, -"revision": "20240802", +"revision": "20240820", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { +"CloudReliabilityZicyWs3DataplaneProtosAssetLocation": { +"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": "CloudReliabilityZicyWs3DataplaneProtosAssetLocation", +"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": "CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectations", +"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": "CloudReliabilityZicyWs3DataplaneProtosExtraParameter" +}, +"type": "array" +}, +"locationData": { +"description": "Contains all kinds of physical location definitions for this asset.", +"items": { +"$ref": "CloudReliabilityZicyWs3DataplaneProtosLocationData" +}, +"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": "CloudReliabilityZicyWs3DataplaneProtosCloudAsset" +}, +"type": "array" +} +}, +"type": "object" +}, +"CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectations": { +"id": "CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectations", +"properties": { +"requirementOverride": { +"$ref": "CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectationsRequirementOverride", +"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" +}, +"CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectationsRequirementOverride": { +"id": "CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectationsRequirementOverride", +"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" +}, +"CloudReliabilityZicyWs3DataplaneProtosBlobstoreLocation": { +"description": "Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains", +"id": "CloudReliabilityZicyWs3DataplaneProtosBlobstoreLocation", +"properties": { +"policyId": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"CloudReliabilityZicyWs3DataplaneProtosCloudAsset": { +"id": "CloudReliabilityZicyWs3DataplaneProtosCloudAsset", +"properties": { +"assetName": { +"type": "string" +}, +"assetType": { +"type": "string" +} +}, +"type": "object" +}, +"CloudReliabilityZicyWs3DataplaneProtosCloudAssetComposition": { +"id": "CloudReliabilityZicyWs3DataplaneProtosCloudAssetComposition", +"properties": { +"childAsset": { +"items": { +"$ref": "CloudReliabilityZicyWs3DataplaneProtosCloudAsset" +}, +"type": "array" +} +}, +"type": "object" +}, +"CloudReliabilityZicyWs3DataplaneProtosDirectLocationAssignment": { +"id": "CloudReliabilityZicyWs3DataplaneProtosDirectLocationAssignment", +"properties": { +"location": { +"items": { +"$ref": "CloudReliabilityZicyWs3DataplaneProtosLocationAssignment" +}, +"type": "array" +} +}, +"type": "object" +}, +"CloudReliabilityZicyWs3DataplaneProtosExtraParameter": { +"description": "Defines parameters that should only be used for specific asset types.", +"id": "CloudReliabilityZicyWs3DataplaneProtosExtraParameter", +"properties": { +"regionalMigDistributionPolicy": { +"$ref": "CloudReliabilityZicyWs3DataplaneProtosRegionalMigDistributionPolicy", +"description": "Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances." +} +}, +"type": "object" +}, +"CloudReliabilityZicyWs3DataplaneProtosLocationAssignment": { +"id": "CloudReliabilityZicyWs3DataplaneProtosLocationAssignment", +"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" +}, +"CloudReliabilityZicyWs3DataplaneProtosLocationData": { +"id": "CloudReliabilityZicyWs3DataplaneProtosLocationData", +"properties": { +"blobstoreLocation": { +"$ref": "CloudReliabilityZicyWs3DataplaneProtosBlobstoreLocation" +}, +"childAssetLocation": { +"$ref": "CloudReliabilityZicyWs3DataplaneProtosCloudAssetComposition" +}, +"directLocation": { +"$ref": "CloudReliabilityZicyWs3DataplaneProtosDirectLocationAssignment" +}, +"gcpProjectProxy": { +"$ref": "CloudReliabilityZicyWs3DataplaneProtosTenantProjectProxy" +}, +"placerLocation": { +"$ref": "CloudReliabilityZicyWs3DataplaneProtosPlacerLocation" +}, +"spannerLocation": { +"$ref": "CloudReliabilityZicyWs3DataplaneProtosSpannerLocation" +} +}, +"type": "object" +}, +"CloudReliabilityZicyWs3DataplaneProtosPlacerLocation": { +"description": "Message describing that the location of the customer resource is tied to placer allocations", +"id": "CloudReliabilityZicyWs3DataplaneProtosPlacerLocation", +"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" +}, +"CloudReliabilityZicyWs3DataplaneProtosRegionalMigDistributionPolicy": { +"description": "To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances", +"id": "CloudReliabilityZicyWs3DataplaneProtosRegionalMigDistributionPolicy", +"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": "CloudReliabilityZicyWs3DataplaneProtosZoneConfiguration" +}, +"type": "array" +} +}, +"type": "object" +}, +"CloudReliabilityZicyWs3DataplaneProtosSpannerLocation": { +"id": "CloudReliabilityZicyWs3DataplaneProtosSpannerLocation", +"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" +}, +"CloudReliabilityZicyWs3DataplaneProtosTenantProjectProxy": { +"id": "CloudReliabilityZicyWs3DataplaneProtosTenantProjectProxy", +"properties": { +"projectNumbers": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"CloudReliabilityZicyWs3DataplaneProtosZoneConfiguration": { +"id": "CloudReliabilityZicyWs3DataplaneProtosZoneConfiguration", +"properties": { +"zone": { +"type": "string" +} +}, +"type": "object" +}, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } ", "id": "Empty", diff --git a/googleapiclient/discovery_cache/documents/datastream.v1.json b/googleapiclient/discovery_cache/documents/datastream.v1.json index 43f21acf3df..8f41a0bd7b9 100644 --- a/googleapiclient/discovery_cache/documents/datastream.v1.json +++ b/googleapiclient/discovery_cache/documents/datastream.v1.json @@ -1065,7 +1065,7 @@ ] }, "run": { -"description": "Use this method to start, resume or recover a stream with a non default CDC strategy. NOTE: This feature is currently experimental.", +"description": "Use this method to start, resume or recover a stream with a non default CDC strategy.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}:run", "httpMethod": "POST", "id": "datastream.projects.locations.streams.run", @@ -1250,7 +1250,7 @@ } } }, -"revision": "20240626", +"revision": "20240814", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AppendOnly": { diff --git a/googleapiclient/discovery_cache/documents/dfareporting.v3.5.json b/googleapiclient/discovery_cache/documents/dfareporting.v3.5.json index e6a8ff8d266..939871e3959 100644 --- a/googleapiclient/discovery_cache/documents/dfareporting.v3.5.json +++ b/googleapiclient/discovery_cache/documents/dfareporting.v3.5.json @@ -161,7 +161,7 @@ } } }, -"revision": "20240625", +"revision": "20240821", "rootUrl": "https://dfareporting.googleapis.com/", "schemas": { "ClickTag": { @@ -399,12 +399,6 @@ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeAssetMetadata\".", "type": "string" }, -"mediaRequestInfo": { -"$ref": "MediaRequestInfo" -}, -"mediaResponseInfo": { -"$ref": "MediaResponseInfo" -}, "richMedia": { "description": "True if the uploaded asset is a rich media asset. This is a read-only, auto-generated field.", "type": "boolean" @@ -630,154 +624,6 @@ }, "type": "object" }, -"MediaRequestInfo": { -"description": "Extra information added to operations that support Scotty media requests.", -"id": "MediaRequestInfo", -"properties": { -"currentBytes": { -"description": "The number of current bytes uploaded or downloaded.", -"format": "int64", -"type": "string" -}, -"customData": { -"description": "Data to be copied to backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.", -"type": "string" -}, -"diffObjectVersion": { -"description": "Set if the http request info is diff encoded. The value of this field is the version number of the base revision. This is corresponding to Apiary's mediaDiffObjectVersion (//depot/google3/java/com/google/api/server/media/variable/DiffObjectVersionVariable.java). See go/esf-scotty-diff-upload for more information.", -"type": "string" -}, -"finalStatus": { -"description": "The existence of the final_status field indicates that this is the last call to the agent for this request_id. http://google3/uploader/agent/scotty_agent.proto?l=737&rcl=347601929", -"format": "int32", -"type": "integer" -}, -"notificationType": { -"description": "The type of notification received from Scotty.", -"enum": [ -"START", -"PROGRESS", -"END", -"RESPONSE_SENT", -"ERROR" -], -"enumDescriptions": [ -"Such requests signals the start of a request containing media upload. Only the media field(s) in the inserted/updated resource are set. The response should either return an error or succeed. On success, responses don't need to contain anything.", -"Such requests signals that the upload has progressed and that the backend might want to access the media file specified in relevant fields in the resource. Only the media field(s) in the inserted/updated resource are set. The response should either return an error or succeed. On success, responses don't need to contain anything.", -"Such requests signals the end of a request containing media upload. END should be handled just like normal Insert/Upload requests, that is, they should process the request and return a complete resource in the response. Pointers to media data (a GFS path usually) appear in the relevant fields in the inserted/updated resource. See gdata.Media in data.proto.", -"Such requests occur after an END and signal that the response has been sent back to the client. RESPONSE_SENT is only sent to the backend if it is configured to receive them. The response does not need to contain anything.", -"Such requests indicate that an error occurred while processing the request. ERROR is only sent to the backend if it is configured to receive them. It is not guaranteed that all errors will result in this notification to the backend, even if the backend requests them. Since these requests are just for informational purposes, the response does not need to contain anything." -], -"type": "string" -}, -"requestId": { -"description": "The Scotty request ID.", -"type": "string" -}, -"requestReceivedParamsServingInfo": { -"description": "The partition of the Scotty server handling this request. type is uploader_service.RequestReceivedParamsServingInfo LINT.IfChange(request_received_params_serving_info_annotations) LINT.ThenChange()", -"format": "byte", -"type": "string" -}, -"totalBytes": { -"description": "The total size of the file.", -"format": "int64", -"type": "string" -}, -"totalBytesIsEstimated": { -"description": "Whether the total bytes field contains an estimated data.", -"type": "boolean" -} -}, -"type": "object" -}, -"MediaResponseInfo": { -"description": "This message is for backends to pass their scotty media specific fields to ESF. Backend will include this in their response message to ESF. Example: ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile(ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse will include apiserving.MediaResponseInfo to tell ESF about data like dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse { optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo media_response_info = 2 }", -"id": "MediaResponseInfo", -"properties": { -"customData": { -"description": "Data to copy from backend response to the next backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.", -"type": "string" -}, -"dataStorageTransform": { -"description": "Specifies any transformation to be applied to data before persisting it or retrieving from storage. E.g., encryption options for blobstore2. This should be of the form uploader_service.DataStorageTransform.", -"format": "byte", -"type": "string" -}, -"dynamicDropTarget": { -"description": "Specifies the Scotty Drop Target to use for uploads. If present in a media response, Scotty does not upload to a standard drop zone. Instead, Scotty saves the upload directly to the location specified in this drop target. Unlike drop zones, the drop target is the final storage location for an upload. So, the agent does not need to clone the blob at the end of the upload. The agent is responsible for garbage collecting any orphaned blobs that may occur due to aborted uploads. For more information, see the drop target design doc here: http://goto/ScottyDropTarget This field will be preferred to dynamicDropzone. If provided, the identified field in the response must be of the type uploader.agent.DropTarget.", -"format": "byte", -"type": "string" -}, -"dynamicDropzone": { -"description": "Specifies the Scotty dropzone to use for uploads.", -"type": "string" -}, -"requestClass": { -"description": "Request class to use for all Blobstore operations for this request.", -"enum": [ -"UNKNOWN_REQUEST_CLASS", -"LATENCY_SENSITIVE", -"PRODUCTION_BATCH", -"BEST_EFFORT" -], -"enumDescriptions": [ -"Unpopulated request_class in log files will be taken as 0 in dremel query. GoogleSQL will try to cast it to enum by default. An unused 0 value is added to avoid GoogleSQL casting error. Please refer to b/69677280.", -"A latency-sensitive request.", -"A request generated by a batch process.", -"A best-effort request." -], -"type": "string" -}, -"scottyAgentUserId": { -"description": "Requester ID passed along to be recorded in the Scotty logs", -"format": "int64", -"type": "string" -}, -"scottyCustomerLog": { -"description": "Customer-specific data to be recorded in the Scotty logs type is logs_proto_scotty.CustomerLog", -"format": "byte", -"type": "string" -}, -"trafficClassField": { -"description": "Specifies the TrafficClass that Scotty should use for any RPCs to fetch the response bytes. Will override the traffic class GTOS of the incoming http request. This is a temporary field to facilitate whitelisting and experimentation by the bigstore agent only. For instance, this does not apply to RTMP reads. WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.", -"enum": [ -"BE1", -"AF1", -"AF2", -"AF3", -"AF4", -"NC1", -"NC0", -"BE0", -"LLQ", -"LLQ1", -"LLQ2", -"LLQ3" -], -"enumDescriptions": [ -"Application-selectable traffic classes Best effort", -"Assured forwarding priority 1", -"Assured forwarding priority 2", -"Assured forwarding priority 3", -"Assured forwarding priority 4", -"Network control", -"Network control", -"Best effort at high packet loss", -"Low-latency queue (LLQ) best effort (go/llq)", -"LLQ assured forwarding priority 1 (go/llq2)", -"LLQ assured forwarding priority 2 (go/llq2)", -"LLQ assured forwarding priority 3 (go/llq3)" -], -"type": "string" -}, -"verifyHashFromHeader": { -"description": "Tells Scotty to verify hashes on the agent's behalf by parsing out the X-Goog-Hash header.", -"type": "boolean" -} -}, -"type": "object" -}, "OffsetPosition": { "description": "Offset Position.", "id": "OffsetPosition", diff --git a/googleapiclient/discovery_cache/documents/dfareporting.v4.json b/googleapiclient/discovery_cache/documents/dfareporting.v4.json index 664feff0f89..8f06e8edfe5 100644 --- a/googleapiclient/discovery_cache/documents/dfareporting.v4.json +++ b/googleapiclient/discovery_cache/documents/dfareporting.v4.json @@ -10067,7 +10067,7 @@ } } }, -"revision": "20240625", +"revision": "20240821", "rootUrl": "https://dfareporting.googleapis.com/", "schemas": { "Account": { @@ -11663,6 +11663,54 @@ }, "type": "object" }, +"CartData": { +"description": "Contains additional information about cart data.", +"id": "CartData", +"properties": { +"items": { +"description": "Data of the items purchased.", +"items": { +"$ref": "CartDataItem" +}, +"type": "array" +}, +"merchantFeedLabel": { +"description": "The feed labels associated with the feed where your items are uploaded. For more information, please refer to \u200b\u200b https://support.google.com/merchants/answer/12453549. This is a required field.", +"type": "string" +}, +"merchantFeedLanguage": { +"description": "The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. This field is needed only when item IDs are not unique across multiple Merchant Center feeds.", +"type": "string" +}, +"merchantId": { +"description": "The Merchant Center ID where the items are uploaded.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"CartDataItem": { +"description": "Contains data of the items purchased.", +"id": "CartDataItem", +"properties": { +"itemId": { +"description": "The shopping id of the item. Must be equal to the Merchant Center product identifier. This is a required field.", +"type": "string" +}, +"quantity": { +"description": "Number of items sold. This is a required field.", +"format": "int32", +"type": "integer" +}, +"unitPrice": { +"description": "Unit price excluding tax, shipping, and any transaction level discounts. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "ChangeLog": { "description": "Describes a change that a user has made to a resource.", "id": "ChangeLog", @@ -12050,6 +12098,10 @@ ], "type": "string" }, +"cartData": { +"$ref": "CartData", +"description": "The cart data associated with this conversion." +}, "childDirectedTreatment": { "description": "Whether this particular request may come from a user under the age of 13, under COPPA compliance.", "type": "boolean" @@ -14964,6 +15016,12 @@ "description": "Name of this directory site.", "type": "string" }, +"publisherSpecificationId": { +"description": "Output only. Default publisher specification ID of video placements under this directory site. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max", +"format": "int64", +"readOnly": true, +"type": "string" +}, "settings": { "$ref": "DirectorySiteSettings", "description": "Directory site settings." @@ -17614,6 +17672,11 @@ "description": "Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.", "type": "boolean" }, +"adServingPlatformId": { +"description": "Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv", +"format": "int64", +"type": "string" +}, "additionalSizes": { "description": "Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.", "items": { @@ -17773,6 +17836,10 @@ "$ref": "DimensionValue", "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field." }, +"siteServed": { +"description": "Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM.", +"type": "boolean" +}, "size": { "$ref": "Size", "description": "Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion." @@ -19568,6 +19635,11 @@ "format": "int64", "type": "string" }, +"adServingPlatformId": { +"description": "Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv", +"format": "int64", +"type": "string" +}, "approved": { "description": "Whether this site is approved.", "type": "boolean" @@ -19819,7 +19891,7 @@ "type": "string" }, "publisherSpecificationId": { -"description": "Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings.", +"description": "Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max", "format": "int64", "type": "string" }, @@ -21119,7 +21191,7 @@ "type": "string" }, "publisherSpecificationId": { -"description": "Publisher specification ID of a video placement.", +"description": "Publisher specification ID of a video placement. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max", "format": "int64", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3.json b/googleapiclient/discovery_cache/documents/dialogflow.v3.json index adba232caeb..f3f25426c38 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3.json @@ -4453,7 +4453,7 @@ } } }, -"revision": "20240812", +"revision": "20240822", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -4572,6 +4572,10 @@ "description": "The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.", "type": "string" }, +"clientCertificateSettings": { +"$ref": "GoogleCloudDialogflowCxV3AgentClientCertificateSettings", +"description": "Optional. Settings for custom client certificates." +}, "defaultLanguageCode": { "description": "Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.", "type": "string" @@ -4658,6 +4662,25 @@ }, "type": "object" }, +"GoogleCloudDialogflowCxV3AgentClientCertificateSettings": { +"description": "Settings for custom client certificates.", +"id": "GoogleCloudDialogflowCxV3AgentClientCertificateSettings", +"properties": { +"passphrase": { +"description": "Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}`", +"type": "string" +}, +"privateKey": { +"description": "Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}`", +"type": "string" +}, +"sslCertificate": { +"description": "Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowCxV3AgentGenAppBuilderSettings": { "description": "Settings for Gen App Builder.", "id": "GoogleCloudDialogflowCxV3AgentGenAppBuilderSettings", diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json index 949c9a4f998..231a478c150 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json @@ -5185,7 +5185,7 @@ } } }, -"revision": "20240812", +"revision": "20240822", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -7636,6 +7636,10 @@ "description": "The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.", "type": "string" }, +"clientCertificateSettings": { +"$ref": "GoogleCloudDialogflowCxV3beta1AgentClientCertificateSettings", +"description": "Optional. Settings for custom client certificates." +}, "defaultLanguageCode": { "description": "Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.", "type": "string" @@ -7726,6 +7730,25 @@ }, "type": "object" }, +"GoogleCloudDialogflowCxV3beta1AgentClientCertificateSettings": { +"description": "Settings for custom client certificates.", +"id": "GoogleCloudDialogflowCxV3beta1AgentClientCertificateSettings", +"properties": { +"passphrase": { +"description": "Optional. The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}`", +"type": "string" +}, +"privateKey": { +"description": "Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}`", +"type": "string" +}, +"sslCertificate": { +"description": "Required. The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowCxV3beta1AgentGenAppBuilderSettings": { "description": "Settings for Gen App Builder.", "id": "GoogleCloudDialogflowCxV3beta1AgentGenAppBuilderSettings", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index 62e06827a6e..56e4206a599 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -496,6 +496,12 @@ "parent" ], "parameters": { +"matcher.fhirMatcher.fhirResources": { +"description": "Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", +"location": "query", +"repeated": true, +"type": "string" +}, "matcher.urisMatcher.uris": { "description": "The exact URIs to match by.", "location": "query", @@ -3790,6 +3796,12 @@ "parent" ], "parameters": { +"matcher.fhirMatcher.fhirResources": { +"description": "Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", +"location": "query", +"repeated": true, +"type": "string" +}, "matcher.urisMatcher.uris": { "description": "The exact URIs to match by.", "location": "query", @@ -5974,7 +5986,7 @@ } } }, -"revision": "20240813", +"revision": "20240817", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -7089,6 +7101,10 @@ "description": "The metadata of a Document.", "id": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata", "properties": { +"dataIngestionSource": { +"description": "The data ingestion source of the Document. Allowed values are: * `batch`: Data ingested via Batch API, e.g., ImportDocuments. * `streaming` Data ingested via Streaming API, e.g., FHIR streaming.", +"type": "string" +}, "lastRefreshedTime": { "description": "The timestamp of the last time the Document was last indexed.", "format": "google-datetime", @@ -7121,6 +7137,10 @@ "description": "The value of the matcher that was used to match the Document.", "id": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", "properties": { +"fhirResource": { +"description": "Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", +"type": "string" +}, "uri": { "description": "If match by URI, the URI of the Document.", "type": "string" @@ -8134,7 +8154,8 @@ "TRAINING_COMPLETE", "READY_FOR_SERVING", "TRAINING_FAILED", -"NO_IMPROVEMENT" +"NO_IMPROVEMENT", +"INPUT_VALIDATION_FAILED" ], "enumDescriptions": [ "Default value.", @@ -8143,7 +8164,8 @@ "The model has successfully completed training.", "The model is ready for serving.", "The model training failed.", -"The model training finished successfully but metrics did not improve." +"The model training finished successfully but metrics did not improve.", +"Input data validation failed. Model training didn't start." ], "type": "string" }, @@ -10603,7 +10625,7 @@ "id": "GoogleCloudDiscoveryengineV1SearchResponse", "properties": { "attributionToken": { -"description": "A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.", +"description": "A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios.", "type": "string" }, "correctedQuery": { @@ -12342,7 +12364,8 @@ "TRAINING_COMPLETE", "READY_FOR_SERVING", "TRAINING_FAILED", -"NO_IMPROVEMENT" +"NO_IMPROVEMENT", +"INPUT_VALIDATION_FAILED" ], "enumDescriptions": [ "Default value.", @@ -12351,7 +12374,8 @@ "The model has successfully completed training.", "The model is ready for serving.", "The model training failed.", -"The model training finished successfully but metrics did not improve." +"The model training finished successfully but metrics did not improve.", +"Input data validation failed. Model training didn't start." ], "type": "string" }, @@ -15445,7 +15469,8 @@ "TRAINING_COMPLETE", "READY_FOR_SERVING", "TRAINING_FAILED", -"NO_IMPROVEMENT" +"NO_IMPROVEMENT", +"INPUT_VALIDATION_FAILED" ], "enumDescriptions": [ "Default value.", @@ -15454,7 +15479,8 @@ "The model has successfully completed training.", "The model is ready for serving.", "The model training failed.", -"The model training finished successfully but metrics did not improve." +"The model training finished successfully but metrics did not improve.", +"Input data validation failed. Model training didn't start." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 55efe3e3902..8a65627f771 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -691,6 +691,12 @@ "parent" ], "parameters": { +"matcher.fhirMatcher.fhirResources": { +"description": "Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", +"location": "query", +"repeated": true, +"type": "string" +}, "matcher.urisMatcher.uris": { "description": "The exact URIs to match by.", "location": "query", @@ -4493,6 +4499,12 @@ "parent" ], "parameters": { +"matcher.fhirMatcher.fhirResources": { +"description": "Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", +"location": "query", +"repeated": true, +"type": "string" +}, "matcher.urisMatcher.uris": { "description": "The exact URIs to match by.", "location": "query", @@ -7505,7 +7517,7 @@ } } }, -"revision": "20240813", +"revision": "20240817", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -10281,6 +10293,10 @@ "description": "The metadata of a Document.", "id": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadata", "properties": { +"dataIngestionSource": { +"description": "The data ingestion source of the Document. Allowed values are: * `batch`: Data ingested via Batch API, e.g., ImportDocuments. * `streaming` Data ingested via Streaming API, e.g., FHIR streaming.", +"type": "string" +}, "lastRefreshedTime": { "description": "The timestamp of the last time the Document was last indexed.", "format": "google-datetime", @@ -10313,6 +10329,10 @@ "description": "The value of the matcher that was used to match the Document.", "id": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", "properties": { +"fhirResource": { +"description": "Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", +"type": "string" +}, "uri": { "description": "If match by URI, the URI of the Document.", "type": "string" @@ -11439,7 +11459,8 @@ "TRAINING_COMPLETE", "READY_FOR_SERVING", "TRAINING_FAILED", -"NO_IMPROVEMENT" +"NO_IMPROVEMENT", +"INPUT_VALIDATION_FAILED" ], "enumDescriptions": [ "Default value.", @@ -11448,7 +11469,8 @@ "The model has successfully completed training.", "The model is ready for serving.", "The model training failed.", -"The model training finished successfully but metrics did not improve." +"The model training finished successfully but metrics did not improve.", +"Input data validation failed. Model training didn't start." ], "type": "string" }, @@ -15442,7 +15464,7 @@ "type": "array" }, "attributionToken": { -"description": "A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.", +"description": "A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios.", "type": "string" }, "correctedQuery": { @@ -15734,6 +15756,10 @@ "description": "Name of the numerical field as defined in the schema.", "type": "string" }, +"querySegment": { +"description": "Identifies the keywords within the search query that match a filter.", +"type": "string" +}, "value": { "description": "The value specified in the numerical constraint.", "format": "double", @@ -17205,7 +17231,8 @@ "TRAINING_COMPLETE", "READY_FOR_SERVING", "TRAINING_FAILED", -"NO_IMPROVEMENT" +"NO_IMPROVEMENT", +"INPUT_VALIDATION_FAILED" ], "enumDescriptions": [ "Default value.", @@ -17214,7 +17241,8 @@ "The model has successfully completed training.", "The model is ready for serving.", "The model training failed.", -"The model training finished successfully but metrics did not improve." +"The model training finished successfully but metrics did not improve.", +"Input data validation failed. Model training didn't start." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index 56fd1ddce8a..37e491f5ad5 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -496,6 +496,12 @@ "parent" ], "parameters": { +"matcher.fhirMatcher.fhirResources": { +"description": "Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", +"location": "query", +"repeated": true, +"type": "string" +}, "matcher.urisMatcher.uris": { "description": "The exact URIs to match by.", "location": "query", @@ -4064,6 +4070,12 @@ "parent" ], "parameters": { +"matcher.fhirMatcher.fhirResources": { +"description": "Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", +"location": "query", +"repeated": true, +"type": "string" +}, "matcher.urisMatcher.uris": { "description": "The exact URIs to match by.", "location": "query", @@ -6774,7 +6786,7 @@ } } }, -"revision": "20240813", +"revision": "20240817", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -9213,7 +9225,8 @@ "TRAINING_COMPLETE", "READY_FOR_SERVING", "TRAINING_FAILED", -"NO_IMPROVEMENT" +"NO_IMPROVEMENT", +"INPUT_VALIDATION_FAILED" ], "enumDescriptions": [ "Default value.", @@ -9222,7 +9235,8 @@ "The model has successfully completed training.", "The model is ready for serving.", "The model training failed.", -"The model training finished successfully but metrics did not improve." +"The model training finished successfully but metrics did not improve.", +"Input data validation failed. Model training didn't start." ], "type": "string" }, @@ -12952,6 +12966,10 @@ "description": "The metadata of a Document.", "id": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadata", "properties": { +"dataIngestionSource": { +"description": "The data ingestion source of the Document. Allowed values are: * `batch`: Data ingested via Batch API, e.g., ImportDocuments. * `streaming` Data ingested via Streaming API, e.g., FHIR streaming.", +"type": "string" +}, "lastRefreshedTime": { "description": "The timestamp of the last time the Document was last indexed.", "format": "google-datetime", @@ -12984,6 +13002,10 @@ "description": "The value of the matcher that was used to match the Document.", "id": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", "properties": { +"fhirResource": { +"description": "Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", +"type": "string" +}, "uri": { "description": "If match by URI, the URI of the Document.", "type": "string" @@ -14010,7 +14032,8 @@ "TRAINING_COMPLETE", "READY_FOR_SERVING", "TRAINING_FAILED", -"NO_IMPROVEMENT" +"NO_IMPROVEMENT", +"INPUT_VALIDATION_FAILED" ], "enumDescriptions": [ "Default value.", @@ -14019,7 +14042,8 @@ "The model has successfully completed training.", "The model is ready for serving.", "The model training failed.", -"The model training finished successfully but metrics did not improve." +"The model training finished successfully but metrics did not improve.", +"Input data validation failed. Model training didn't start." ], "type": "string" }, @@ -17147,7 +17171,7 @@ "type": "array" }, "attributionToken": { -"description": "A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.", +"description": "A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios.", "type": "string" }, "correctedQuery": { @@ -17439,6 +17463,10 @@ "description": "Name of the numerical field as defined in the schema.", "type": "string" }, +"querySegment": { +"description": "Identifies the keywords within the search query that match a filter.", +"type": "string" +}, "value": { "description": "The value specified in the numerical constraint.", "format": "double", diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index e09a7d339b8..3a9dbf0c300 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -1432,7 +1432,7 @@ ], "parameters": { "filter": { -"description": "Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like \"gs://bucket\". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = \"gs://mybucket\"` The length of this field should be no more than 500 characters.", +"description": "Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like \"gs://bucket\". - `data_source_type` - The profile's data source type, like \"google/storage/bucket\". - `data_storage_location` - The location where the file store's data is stored, like \"us-central1\". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = \"gs://mybucket\"` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -4065,7 +4065,7 @@ ], "parameters": { "filter": { -"description": "Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like \"gs://bucket\". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = \"gs://mybucket\"` The length of this field should be no more than 500 characters.", +"description": "Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like \"gs://bucket\". - `data_source_type` - The profile's data source type, like \"google/storage/bucket\". - `data_storage_location` - The location where the file store's data is stored, like \"us-central1\". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = \"gs://mybucket\"` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -5015,7 +5015,7 @@ } } }, -"revision": "20240808", +"revision": "20240818", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { diff --git a/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json b/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json index 83d505dea0f..0dc55026671 100644 --- a/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json +++ b/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json @@ -224,7 +224,7 @@ } } }, -"revision": "20240701", +"revision": "20240821", "rootUrl": "https://firebasedynamiclinks.googleapis.com/", "schemas": { "AnalyticsInfo": { @@ -520,6 +520,13 @@ false "$ref": "DynamicLinkEventStat" }, "type": "array" +}, +"warnings": { +"description": "Optional warnings associated this API request.", +"items": { +"$ref": "DynamicLinkWarning" +}, +"type": "array" } }, "type": "object" @@ -559,7 +566,8 @@ false "BAD_URI_SCHEME_SOCIAL_URL", "LINK_LENGTH_TOO_LONG", "LINK_WITH_FRAGMENTS", -"NOT_MATCHING_IOS_BUNDLE_ID_AND_STORE_ID" +"NOT_MATCHING_IOS_BUNDLE_ID_AND_STORE_ID", +"API_DEPRECATED" ], "enumDescriptions": [ "Unknown code.", @@ -582,15 +590,16 @@ false "Debug param format is incorrect.", "isAd param format is incorrect.", "Indicates a certain param is deprecated.", -"Indicates certain paramater is not recognized.", -"Indicates certain paramater is too long.", +"Indicates certain parameter is not recognized.", +"Indicates certain parameter is too long.", "Social meta tag image link is not a valid URI.", "Social meta tag image link has an invalid (non http/https) URI scheme.", "", "", "Dynamic Link URL length is too long.", "Dynamic Link URL contains fragments.", -"The iOS bundle ID does not match with the given iOS store ID." +"The iOS bundle ID does not match with the given iOS store ID.", +"The API is deprecated." ], "type": "string" }, @@ -818,6 +827,13 @@ false "utmTerm": { "description": "Scion term value to be propagated by iSDK to Scion at app-reopen.", "type": "string" +}, +"warning": { +"description": "Optional warnings associated this API request.", +"items": { +"$ref": "DynamicLinkWarning" +}, +"type": "array" } }, "type": "object" @@ -930,7 +946,7 @@ false ], "enumDescriptions": [ "Indicates that no attributes were found for this short url.", -"Indicates that short url has been flagged by AbuseIAm team as spam." +"Indicates that short url has been flagged as spam." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index 14e2d5c9920..076d58d8773 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20240813", +"revision": "20240821", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -548,7 +548,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Required. The function response in JSON object format.", +"description": "Required. The function response in JSON object format. Use \"output\" key to specify function output and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as function output.", "type": "object" } }, @@ -665,6 +665,12 @@ "description": "Usage metadata about response(s).", "id": "GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata", "properties": { +"cachedContentTokenCount": { +"description": "Output only. Number of tokens in the cached part in the input (the cached content).", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "candidatesTokenCount": { "description": "Number of tokens in the response(s).", "format": "int32", @@ -676,6 +682,7 @@ "type": "integer" }, "totalTokenCount": { +"description": "Total token count for prompt and response candidates.", "format": "int32", "type": "integer" } @@ -1104,7 +1111,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Schema": { -"description": "Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed.", +"description": "Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed.", "id": "GoogleCloudAiplatformV1beta1Schema", "properties": { "default": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json index 35f7d2d65e7..cb9220db91a 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json @@ -2111,7 +2111,7 @@ } } }, -"revision": "20240809", +"revision": "20240815", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2520,7 +2520,7 @@ "type": "object" }, "CommonFeatureSpec": { -"description": "CommonFeatureSpec contains Hub-wide configuration information", +"description": "CommonFeatureSpec contains Fleet-wide configuration information", "id": "CommonFeatureSpec", "properties": { "appdevexperience": { @@ -2547,7 +2547,7 @@ "type": "object" }, "CommonFeatureState": { -"description": "CommonFeatureState contains Hub-wide Feature status information.", +"description": "CommonFeatureState contains Fleet-wide Feature status information.", "id": "CommonFeatureState", "properties": { "appdevexperience": { @@ -2564,7 +2564,7 @@ }, "state": { "$ref": "FeatureState", -"description": "Output only. The \"running state\" of the Feature in this Hub.", +"description": "Output only. The \"running state\" of the Feature in this Fleet.", "readOnly": true } }, @@ -3230,7 +3230,7 @@ }, "hierarchyController": { "$ref": "ConfigManagementHierarchyControllerConfig", -"description": "Hierarchy Controller configuration for the cluster." +"description": "Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead." }, "management": { "description": "Enables automatic Feature management.", @@ -3649,7 +3649,7 @@ "type": "object" }, "Feature": { -"description": "Feature represents the settings and status of any Hub Feature.", +"description": "Feature represents the settings and status of any Fleet Feature.", "id": "Feature", "properties": { "createTime": { @@ -3717,11 +3717,11 @@ }, "spec": { "$ref": "CommonFeatureSpec", -"description": "Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused." +"description": "Optional. Fleet-wide Feature configuration. If this Feature does not support any Fleet-wide configuration, this field may be unused." }, "state": { "$ref": "CommonFeatureState", -"description": "Output only. The Hub-wide Feature state.", +"description": "Output only. The Fleet-wide Feature state.", "readOnly": true }, "unreachable": { @@ -3742,7 +3742,7 @@ "type": "object" }, "FeatureResourceState": { -"description": "FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the \"running state\" of the Feature in the Hub and across Memberships.", +"description": "FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the \"running state\" of the Feature in the Fleet and across Memberships.", "id": "FeatureResourceState", "properties": { "state": { @@ -3757,9 +3757,9 @@ ], "enumDescriptions": [ "State is unknown or not set.", -"The Feature is being enabled, and the Feature resource is being created. Once complete, the corresponding Feature will be enabled in this Hub.", -"The Feature is enabled in this Hub, and the Feature resource is fully available.", -"The Feature is being disabled in this Hub, and the Feature resource is being deleted.", +"The Feature is being enabled, and the Feature resource is being created. Once complete, the corresponding Feature will be enabled in this Fleet.", +"The Feature is enabled in this Fleet, and the Feature resource is fully available.", +"The Feature is being disabled in this Fleet, and the Feature resource is being deleted.", "The Feature resource is being updated.", "The Feature resource is being updated by the Hub Service." ], @@ -5007,7 +5007,7 @@ "type": "object" }, "MembershipFeatureSpec": { -"description": "MembershipFeatureSpec contains configuration information for a single Membership. NOTE: Please use snake case in your feature name.", +"description": "MembershipFeatureSpec contains configuration information for a single Membership.", "id": "MembershipFeatureSpec", "properties": { "configmanagement": { @@ -6074,6 +6074,7 @@ "enum": [ "CODE_UNSPECIFIED", "MESH_IAM_PERMISSION_DENIED", +"MESH_IAM_CROSS_PROJECT_PERMISSION_DENIED", "CNI_CONFIG_UNSUPPORTED", "GKE_SANDBOX_UNSUPPORTED", "NODEPOOL_WORKLOAD_IDENTITY_FEDERATION_REQUIRED", @@ -6103,6 +6104,7 @@ "enumDescriptions": [ "Default Unspecified code", "Mesh IAM permission denied error code", +"Permission denied error code for cross-project", "CNI config unsupported error code", "GKE sandbox unsupported error code", "Nodepool workload identity federation required error code", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json index 7de05b662e4..547410205fb 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json @@ -2185,7 +2185,7 @@ } } }, -"revision": "20240809", +"revision": "20240815", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -2720,7 +2720,7 @@ "type": "object" }, "CommonFeatureSpec": { -"description": "CommonFeatureSpec contains Hub-wide configuration information", +"description": "CommonFeatureSpec contains Fleet-wide configuration information", "id": "CommonFeatureSpec", "properties": { "anthosobservability": { @@ -2763,7 +2763,7 @@ "type": "object" }, "CommonFeatureState": { -"description": "CommonFeatureState contains Hub-wide Feature status information.", +"description": "CommonFeatureState contains Fleet-wide Feature status information.", "id": "CommonFeatureState", "properties": { "appdevexperience": { @@ -2788,7 +2788,7 @@ }, "state": { "$ref": "FeatureState", -"description": "Output only. The \"running state\" of the Feature in this Hub.", +"description": "Output only. The \"running state\" of the Feature in this Fleet.", "readOnly": true } }, @@ -3510,7 +3510,7 @@ }, "hierarchyController": { "$ref": "ConfigManagementHierarchyControllerConfig", -"description": "Hierarchy Controller configuration for the cluster." +"description": "Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead." }, "management": { "description": "Enables automatic Feature management.", @@ -3933,7 +3933,7 @@ "type": "object" }, "Feature": { -"description": "Feature represents the settings and status of any Hub Feature.", +"description": "Feature represents the settings and status of any Fleet Feature.", "id": "Feature", "properties": { "createTime": { @@ -4001,11 +4001,11 @@ }, "spec": { "$ref": "CommonFeatureSpec", -"description": "Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused." +"description": "Optional. Fleet-wide Feature configuration. If this Feature does not support any Fleet-wide configuration, this field may be unused." }, "state": { "$ref": "CommonFeatureState", -"description": "Output only. The Hub-wide Feature state.", +"description": "Output only. The Fleet-wide Feature state.", "readOnly": true }, "unreachable": { @@ -4026,7 +4026,7 @@ "type": "object" }, "FeatureResourceState": { -"description": "FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the \"running state\" of the Feature in the Hub and across Memberships.", +"description": "FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the \"running state\" of the Feature in the Fleet and across Memberships.", "id": "FeatureResourceState", "properties": { "state": { @@ -4041,9 +4041,9 @@ ], "enumDescriptions": [ "State is unknown or not set.", -"The Feature is being enabled, and the Feature resource is being created. Once complete, the corresponding Feature will be enabled in this Hub.", -"The Feature is enabled in this Hub, and the Feature resource is fully available.", -"The Feature is being disabled in this Hub, and the Feature resource is being deleted.", +"The Feature is being enabled, and the Feature resource is being created. Once complete, the corresponding Feature will be enabled in this Fleet.", +"The Feature is enabled in this Fleet, and the Feature resource is fully available.", +"The Feature is being disabled in this Fleet, and the Feature resource is being deleted.", "The Feature resource is being updated.", "The Feature resource is being updated by the Hub Service." ], @@ -5345,7 +5345,7 @@ "type": "object" }, "MembershipFeatureSpec": { -"description": "MembershipFeatureSpec contains configuration information for a single Membership. NOTE: Please use snake case in your feature name.", +"description": "MembershipFeatureSpec contains configuration information for a single Membership.", "id": "MembershipFeatureSpec", "properties": { "anthosobservability": { @@ -6598,6 +6598,7 @@ "enum": [ "CODE_UNSPECIFIED", "MESH_IAM_PERMISSION_DENIED", +"MESH_IAM_CROSS_PROJECT_PERMISSION_DENIED", "CNI_CONFIG_UNSUPPORTED", "GKE_SANDBOX_UNSUPPORTED", "NODEPOOL_WORKLOAD_IDENTITY_FEDERATION_REQUIRED", @@ -6627,6 +6628,7 @@ "enumDescriptions": [ "Default Unspecified code", "Mesh IAM permission denied error code", +"Permission denied error code for cross-project", "CNI config unsupported error code", "GKE sandbox unsupported error code", "Nodepool workload identity federation required error code", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json index 59b7fe4c387..f42623d63a0 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json @@ -2111,7 +2111,7 @@ } } }, -"revision": "20240809", +"revision": "20240815", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -2550,7 +2550,7 @@ "type": "object" }, "CommonFeatureSpec": { -"description": "CommonFeatureSpec contains Hub-wide configuration information", +"description": "CommonFeatureSpec contains Fleet-wide configuration information", "id": "CommonFeatureSpec", "properties": { "anthosobservability": { @@ -2581,7 +2581,7 @@ "type": "object" }, "CommonFeatureState": { -"description": "CommonFeatureState contains Hub-wide Feature status information.", +"description": "CommonFeatureState contains Fleet-wide Feature status information.", "id": "CommonFeatureState", "properties": { "appdevexperience": { @@ -2598,7 +2598,7 @@ }, "state": { "$ref": "FeatureState", -"description": "Output only. The \"running state\" of the Feature in this Hub.", +"description": "Output only. The \"running state\" of the Feature in this Fleet.", "readOnly": true } }, @@ -3320,7 +3320,7 @@ }, "hierarchyController": { "$ref": "ConfigManagementHierarchyControllerConfig", -"description": "Hierarchy Controller configuration for the cluster." +"description": "Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead." }, "management": { "description": "Enables automatic Feature management.", @@ -3743,7 +3743,7 @@ "type": "object" }, "Feature": { -"description": "Feature represents the settings and status of any Hub Feature.", +"description": "Feature represents the settings and status of any Fleet Feature.", "id": "Feature", "properties": { "createTime": { @@ -3811,11 +3811,11 @@ }, "spec": { "$ref": "CommonFeatureSpec", -"description": "Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused." +"description": "Optional. Fleet-wide Feature configuration. If this Feature does not support any Fleet-wide configuration, this field may be unused." }, "state": { "$ref": "CommonFeatureState", -"description": "Output only. The Hub-wide Feature state.", +"description": "Output only. The Fleet-wide Feature state.", "readOnly": true }, "unreachable": { @@ -3836,7 +3836,7 @@ "type": "object" }, "FeatureResourceState": { -"description": "FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the \"running state\" of the Feature in the Hub and across Memberships.", +"description": "FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the \"running state\" of the Feature in the Fleet and across Memberships.", "id": "FeatureResourceState", "properties": { "state": { @@ -3851,9 +3851,9 @@ ], "enumDescriptions": [ "State is unknown or not set.", -"The Feature is being enabled, and the Feature resource is being created. Once complete, the corresponding Feature will be enabled in this Hub.", -"The Feature is enabled in this Hub, and the Feature resource is fully available.", -"The Feature is being disabled in this Hub, and the Feature resource is being deleted.", +"The Feature is being enabled, and the Feature resource is being created. Once complete, the corresponding Feature will be enabled in this Fleet.", +"The Feature is enabled in this Fleet, and the Feature resource is fully available.", +"The Feature is being disabled in this Fleet, and the Feature resource is being deleted.", "The Feature resource is being updated.", "The Feature resource is being updated by the Hub Service." ], @@ -5101,7 +5101,7 @@ "type": "object" }, "MembershipFeatureSpec": { -"description": "MembershipFeatureSpec contains configuration information for a single Membership. NOTE: Please use snake case in your feature name.", +"description": "MembershipFeatureSpec contains configuration information for a single Membership.", "id": "MembershipFeatureSpec", "properties": { "anthosobservability": { @@ -6237,6 +6237,7 @@ "enum": [ "CODE_UNSPECIFIED", "MESH_IAM_PERMISSION_DENIED", +"MESH_IAM_CROSS_PROJECT_PERMISSION_DENIED", "CNI_CONFIG_UNSUPPORTED", "GKE_SANDBOX_UNSUPPORTED", "NODEPOOL_WORKLOAD_IDENTITY_FEDERATION_REQUIRED", @@ -6266,6 +6267,7 @@ "enumDescriptions": [ "Default Unspecified code", "Mesh IAM permission denied error code", +"Permission denied error code for cross-project", "CNI config unsupported error code", "GKE sandbox unsupported error code", "Nodepool workload identity federation required error code", diff --git a/googleapiclient/discovery_cache/documents/gkeonprem.v1.json b/googleapiclient/discovery_cache/documents/gkeonprem.v1.json index ba05a8f7cf2..7b512bb3f10 100644 --- a/googleapiclient/discovery_cache/documents/gkeonprem.v1.json +++ b/googleapiclient/discovery_cache/documents/gkeonprem.v1.json @@ -188,6 +188,11 @@ "parent" ], "parameters": { +"allowPreflightFailure": { +"description": "Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with \"cluster already exists\" error and hence a update cluster is required to fix the cluster.", +"location": "query", +"type": "boolean" +}, "bareMetalAdminClusterId": { "description": "Required. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/", "location": "query", @@ -254,6 +259,11 @@ "name" ], "parameters": { +"allowMissing": { +"description": "Optional. If true, return BareMetal Admin Cluster including the one that only exists in RMS.", +"location": "query", +"type": "boolean" +}, "name": { "description": "Required. Name of the bare metal admin cluster to get. Format: \"projects/{project}/locations/{location}/bareMetalAdminClusters/{bare_metal_admin_cluster}\"", "location": "path", @@ -325,6 +335,11 @@ "parent" ], "parameters": { +"allowMissing": { +"description": "Optional. If true, return list of BareMetal Admin Clusters including the ones that only exists in RMS.", +"location": "query", +"type": "boolean" +}, "pageSize": { "description": "Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", @@ -622,6 +637,11 @@ "parent" ], "parameters": { +"allowPreflightFailure": { +"description": "Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with \"cluster already exists\" error and hence a update cluster is required to fix the cluster.", +"location": "query", +"type": "boolean" +}, "bareMetalClusterId": { "description": "Required. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/", "location": "query", @@ -738,6 +758,11 @@ "name" ], "parameters": { +"allowMissing": { +"description": "Optional. If true, return BareMetal Cluster including the one that only exists in RMS.", +"location": "query", +"type": "boolean" +}, "name": { "description": "Required. Name of the bare metal user cluster to get. Format: \"projects/{project}/locations/{location}/bareMetalClusters/{bare_metal_cluster}\"", "location": "path", @@ -809,6 +834,11 @@ "parent" ], "parameters": { +"allowMissing": { +"description": "Optional. If true, return list of BareMetal Clusters including the ones that only exists in RMS.", +"location": "query", +"type": "boolean" +}, "filter": { "description": "A resource filtering expression following https://google.aip.dev/160. When non-empty, only resource's whose attributes field matches the filter are returned.", "location": "query", @@ -1726,6 +1756,11 @@ "name" ], "parameters": { +"allowMissing": { +"description": "Optional. If true, return Vmware Admin Cluster including the one that only exists in RMS.", +"location": "query", +"type": "boolean" +}, "name": { "description": "Required. Name of the VMware admin cluster to be returned. Format: \"projects/{project}/locations/{location}/vmwareAdminClusters/{vmware_admin_cluster}\"", "location": "path", @@ -1797,6 +1832,11 @@ "parent" ], "parameters": { +"allowMissing": { +"description": "Optional. If true, return list of Vmware Admin Clusters including the ones that only exists in RMS.", +"location": "query", +"type": "boolean" +}, "pageSize": { "description": "Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", @@ -2059,6 +2099,11 @@ "parent" ], "parameters": { +"allowPreflightFailure": { +"description": "Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with \"cluster already exists\" error and hence a update cluster is required to fix the cluster.", +"location": "query", +"type": "boolean" +}, "parent": { "description": "Required. The parent of the project and location where this cluster is created in. Format: \"projects/{project}/locations/{location}\"", "location": "path", @@ -2175,6 +2220,11 @@ "name" ], "parameters": { +"allowMissing": { +"description": "Optional. If true, return Vmware Cluster including the one that only exists in RMS.", +"location": "query", +"type": "boolean" +}, "name": { "description": "Required. Name of the VMware user cluster to be returned. Format: \"projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}\"", "location": "path", @@ -2246,6 +2296,11 @@ "parent" ], "parameters": { +"allowMissing": { +"description": "Optional. If true, return list of Vmware Clusters including the ones that only exists in RMS.", +"location": "query", +"type": "boolean" +}, "filter": { "description": "A resource filtering expression following https://google.aip.dev/160. When non-empty, only resource's whose attributes field matches the filter are returned.", "location": "query", @@ -2996,7 +3051,7 @@ } } }, -"revision": "20240228", +"revision": "20240814", "rootUrl": "https://gkeonprem.googleapis.com/", "schemas": { "Authorization": { @@ -3719,6 +3774,11 @@ "description": "BareMetalClusterUpgradePolicy defines the cluster upgrade policy.", "id": "BareMetalClusterUpgradePolicy", "properties": { +"pause": { +"description": "Output only. Pause is used to show the upgrade pause status. It's view only for now.", +"readOnly": true, +"type": "boolean" +}, "policy": { "description": "Specifies which upgrade policy to use.", "enum": [ @@ -5182,6 +5242,14 @@ "errorMessage": { "description": "Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention.", "type": "string" +}, +"version": { +"description": "Reflect current version of the resource.", +"type": "string" +}, +"versions": { +"$ref": "Versions", +"description": "Shows the mapping of a given version to the number of machines under this version." } }, "type": "object" @@ -5371,6 +5439,36 @@ }, "type": "object" }, +"Version": { +"description": "Version describes the number of nodes at a given version under a resource.", +"id": "Version", +"properties": { +"count": { +"description": "Number of machines under the above version.", +"format": "int64", +"type": "string" +}, +"version": { +"description": "Resource version.", +"type": "string" +} +}, +"type": "object" +}, +"Versions": { +"description": "Versions describes the mapping of a given version to the number of machines under this version.", +"id": "Versions", +"properties": { +"versions": { +"description": "Shows the mapping of a given version to the number of machines under this version.", +"items": { +"$ref": "Version" +}, +"type": "array" +} +}, +"type": "object" +}, "VmwareAAGConfig": { "description": "Specifies anti affinity group config for the VMware user cluster.", "id": "VmwareAAGConfig", @@ -5570,6 +5668,11 @@ "readOnly": true, "type": "string" }, +"validationCheck": { +"$ref": "ValidationCheck", +"description": "Output only. ValidationCheck represents the result of the preflight check job.", +"readOnly": true +}, "vcenter": { "$ref": "VmwareAdminVCenterConfig", "description": "The VMware admin cluster VCenter configuration." @@ -6727,7 +6830,7 @@ } }, "servicePath": "", -"title": "Anthos On-Prem API", +"title": "GDC Virtual API", "version": "v1", "version_module": true } \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/integrations.v1.json b/googleapiclient/discovery_cache/documents/integrations.v1.json index 0bd850b5e2d..ce12fcefa93 100644 --- a/googleapiclient/discovery_cache/documents/integrations.v1.json +++ b/googleapiclient/discovery_cache/documents/integrations.v1.json @@ -4084,7 +4084,7 @@ } } }, -"revision": "20240812", +"revision": "20240819", "rootUrl": "https://integrations.googleapis.com/", "schemas": { "CrmlogErrorCode": { @@ -5509,8 +5509,7 @@ false "$ref": "EnterpriseCrmEventbusProtoIntFunction" }, "jsonFunction": { -"$ref": "EnterpriseCrmEventbusProtoJsonFunction", -"description": "LINT.ThenChange(//depot/google3/alkali/apps/integrationplatform/client/workflow_editor/utils/transform_function.ts)" +"$ref": "EnterpriseCrmEventbusProtoJsonFunction" }, "protoArrayFunction": { "$ref": "EnterpriseCrmEventbusProtoProtoArrayFunction" diff --git a/googleapiclient/discovery_cache/documents/looker.v1.json b/googleapiclient/discovery_cache/documents/looker.v1.json index bed2f2d973e..b6b5eb27275 100644 --- a/googleapiclient/discovery_cache/documents/looker.v1.json +++ b/googleapiclient/discovery_cache/documents/looker.v1.json @@ -731,7 +731,7 @@ } } }, -"revision": "20240522", +"revision": "20240814", "rootUrl": "https://looker.googleapis.com/", "schemas": { "AdminSettings": { @@ -1163,6 +1163,14 @@ "description": "Whether private IP is enabled on the Looker instance.", "type": "boolean" }, +"pscConfig": { +"$ref": "PscConfig", +"description": "Optional. PSC configuration. Used when `psc_enabled` is true." +}, +"pscEnabled": { +"description": "Optional. Whether to use Private Service Connect (PSC) for private IP connectivity. If true, neither `public_ip_enabled` nor `private_ip_enabled` can be true.", +"type": "boolean" +}, "publicIpEnabled": { "description": "Whether public IP is enabled on the Looker instance.", "type": "boolean" @@ -1476,12 +1484,74 @@ }, "type": "object" }, +"PscConfig": { +"description": "Information for Private Service Connect (PSC) setup for a Looker instance.", +"id": "PscConfig", +"properties": { +"allowedVpcs": { +"description": "Optional. List of VPCs that are allowed ingress into looker. Format: projects/{project}/global/networks/{network}", +"items": { +"type": "string" +}, +"type": "array" +}, +"lookerServiceAttachmentUri": { +"description": "Output only. URI of the Looker service attachment.", +"readOnly": true, +"type": "string" +}, +"serviceAttachments": { +"description": "Optional. List of egress service attachment configurations.", +"items": { +"$ref": "ServiceAttachment" +}, +"type": "array" +} +}, +"type": "object" +}, "RestartInstanceRequest": { "description": "Request options for restarting an instance.", "id": "RestartInstanceRequest", "properties": {}, "type": "object" }, +"ServiceAttachment": { +"description": "Service attachment configuration.", +"id": "ServiceAttachment", +"properties": { +"connectionStatus": { +"description": "Output only. Connection status.", +"enum": [ +"UNKNOWN", +"ACCEPTED", +"PENDING", +"REJECTED", +"NEEDS_ATTENTION", +"CLOSED" +], +"enumDescriptions": [ +"Connection status is unspecified.", +"Connection is established and functioning normally.", +"Connection is not established (Looker tenant project hasn't been allowlisted).", +"Connection is not established (Looker tenant project is explicitly in reject list).", +"Issue with target service attachment, e.g. NAT subnet is exhausted.", +"Target service attachment does not exist. This status is a terminal state." +], +"readOnly": true, +"type": "string" +}, +"localFqdn": { +"description": "Required. Fully qualified domain name that will be used in the private DNS record created for the service attachment.", +"type": "string" +}, +"targetServiceAttachmentUri": { +"description": "Required. URI of the service attachment to connect to. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}", +"type": "string" +} +}, +"type": "object" +}, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json index f54ef91992f..2b5051dc093 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json @@ -1354,7 +1354,7 @@ } } }, -"revision": "20240806", +"revision": "20240821", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AcceptTermsOfService": { @@ -1608,6 +1608,10 @@ "$ref": "CustomerService", "description": "Optional. The customer service of the business." }, +"koreanBusinessRegistrationNumber": { +"description": "Optional. The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX.", +"type": "string" +}, "name": { "description": "Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json index 6ffd90dafed..078cec2959a 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json @@ -1862,6 +1862,81 @@ } } }, +"relations": { +"methods": { +"get": { +"description": "Gets the details of an relation.", +"flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/relations/{relationsId}", +"httpMethod": "GET", +"id": "migrationcenter.projects.locations.relations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/relations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha1/{+name}", +"response": { +"$ref": "Relation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists all the relations in a given project and location.", +"flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/relations", +"httpMethod": "GET", +"id": "migrationcenter.projects.locations.relations.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Filtering results.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field to sort by. See https://google.aip.dev/132#ordering for more details.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for `ListRelationsRequest`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha1/{+parent}/relations", +"response": { +"$ref": "ListRelationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "reportConfigs": { "methods": { "create": { @@ -2473,7 +2548,7 @@ } } }, -"revision": "20240808", +"revision": "20240815", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -3048,6 +3123,13 @@ "description": "Optional. When this value is set to `true` the request is a no-op for non-existing assets. See https://google.aip.dev/135#delete-if-existing for additional details. Default value is `false`.", "type": "boolean" }, +"cascadingRules": { +"description": "Optional. Optional cascading rules for deleting related assets.", +"items": { +"$ref": "CascadingRule" +}, +"type": "array" +}, "names": { "description": "Required. The IDs of the assets to delete. A maximum of 1000 assets can be deleted in a batch. Format: projects/{project}/locations/{location}/assets/{name}.", "items": { @@ -3119,6 +3201,23 @@ "properties": {}, "type": "object" }, +"CascadeLogicalDBsRule": { +"description": "Cascading rule for related logical DBs.", +"id": "CascadeLogicalDBsRule", +"properties": {}, +"type": "object" +}, +"CascadingRule": { +"description": "Specifies cascading rules for traversing relations.", +"id": "CascadingRule", +"properties": { +"cascadeLogicalDbs": { +"$ref": "CascadeLogicalDBsRule", +"description": "Cascading rule for related logical DBs." +} +}, +"type": "object" +}, "CloudDatabaseMigrationTarget": { "description": "Cloud database migration target.", "id": "CloudDatabaseMigrationTarget", @@ -5659,6 +5758,24 @@ false }, "type": "object" }, +"ListRelationsResponse": { +"description": "Response message for listing relations.", +"id": "ListRelationsResponse", +"properties": { +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"relations": { +"description": "A list of relations.", +"items": { +"$ref": "Relation" +}, +"type": "array" +} +}, +"type": "object" +}, "ListReportConfigsResponse": { "description": "Response message for listing report configs.", "id": "ListReportConfigsResponse", @@ -6641,6 +6758,48 @@ false }, "type": "object" }, +"Relation": { +"description": "Message representing a relation between 2 resource.", +"id": "Relation", +"properties": { +"createTime": { +"description": "Output only. The timestamp when the relation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"dstAsset": { +"description": "Output only. The destination asset name in the relation.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. Identifier. The identifier of the relation.", +"readOnly": true, +"type": "string" +}, +"srcAsset": { +"description": "Output only. The source asset name in the relation.", +"readOnly": true, +"type": "string" +}, +"type": { +"description": "Optional. The type of the relation.", +"enum": [ +"TYPE_UNSPECIFIED", +"LOGICAL_DATABASE", +"DATABASE_DEPLOYMENT_HOSTING_SERVER" +], +"enumDescriptions": [ +"Default value.", +"DBDeployment -> Database", +"A relation between a machine/VM and the database deployment it hosts." +], +"type": "string" +} +}, +"type": "object" +}, "RemoveAssetsFromGroupRequest": { "description": "A request to remove assets from a group.", "id": "RemoveAssetsFromGroupRequest", diff --git a/googleapiclient/discovery_cache/documents/monitoring.v3.json b/googleapiclient/discovery_cache/documents/monitoring.v3.json index 3147f36a9e7..1f5953007f0 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v3.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v3.json @@ -2113,6 +2113,7 @@ ] }, "query": { +"deprecated": true, "description": "Queries time series using Monitoring Query Language.", "flatPath": "v3/projects/{projectsId}/timeSeries:query", "httpMethod": "POST", @@ -2714,7 +2715,7 @@ } } }, -"revision": "20240804", +"revision": "20240818", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -5195,6 +5196,7 @@ "type": "object" }, "QueryTimeSeriesRequest": { +"deprecated": true, "description": "The QueryTimeSeries request.", "id": "QueryTimeSeriesRequest", "properties": { @@ -5215,6 +5217,7 @@ "type": "object" }, "QueryTimeSeriesResponse": { +"deprecated": true, "description": "The QueryTimeSeries response.", "id": "QueryTimeSeriesResponse", "properties": { diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index e6fe66b3d87..f94eabb93c4 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 considrered 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. The following fields are not considrered 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": "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 ", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/vpcFlowLogsConfigs/{vpcFlowLogsConfigsId}", "httpMethod": "PATCH", "id": "networkmanagement.projects.locations.vpcFlowLogsConfigs.patch", @@ -758,7 +758,7 @@ } } }, -"revision": "20240807", +"revision": "20240812", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1543,6 +1543,14 @@ false "projectId": { "description": "Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a Google Cloud project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.", "type": "string" +}, +"redisCluster": { +"description": "A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) URI.", +"type": "string" +}, +"redisInstance": { +"description": "A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) URI.", +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1.json b/googleapiclient/discovery_cache/documents/networkservices.v1.json index 8c7ea65331f..13aa216a21e 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1.json @@ -2408,7 +2408,7 @@ } } }, -"revision": "20240721", +"revision": "20240818", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -2814,6 +2814,18 @@ }, "type": "array" }, +"routingMode": { +"description": "Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY.", +"enum": [ +"EXPLICIT_ROUTING_MODE", +"NEXT_HOP_ROUTING_MODE" +], +"enumDescriptions": [ +"The routing mode is explicit; clients are configured to send traffic through the gateway. This is the default routing mode.", +"The routing mode is next-hop. Clients are unaware of the gateway, and a route (advanced route or other route type) can be configured to direct traffic from client to gateway. The gateway then acts as a next-hop to the destination." +], +"type": "string" +}, "scope": { "description": "Optional. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens.", "type": "string" @@ -3049,7 +3061,7 @@ "type": "object" }, "GrpcRouteRetryPolicy": { -"description": "The specifications for retries.", +"description": "The specifications for retries. Specifies one or more conditions for which this retry rule applies. Valid values are:", "id": "GrpcRouteRetryPolicy", "properties": { "numRetries": { diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json index e029e8ea144..728e3b679dc 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json @@ -2317,7 +2317,7 @@ } } }, -"revision": "20240721", +"revision": "20240818", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -2772,6 +2772,18 @@ }, "type": "array" }, +"routingMode": { +"description": "Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY.", +"enum": [ +"EXPLICIT_ROUTING_MODE", +"NEXT_HOP_ROUTING_MODE" +], +"enumDescriptions": [ +"The routing mode is explicit; clients are configured to send traffic through the gateway. This is the default routing mode.", +"The routing mode is next-hop. Clients are unaware of the gateway, and a route (advanced route or other route type) can be configured to direct traffic from client to gateway. The gateway then acts as a next-hop to the destination." +], +"type": "string" +}, "scope": { "description": "Optional. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens.", "type": "string" @@ -3007,7 +3019,7 @@ "type": "object" }, "GrpcRouteRetryPolicy": { -"description": "The specifications for retries.", +"description": "The specifications for retries. Specifies one or more conditions for which this retry rule applies. Valid values are:", "id": "GrpcRouteRetryPolicy", "properties": { "numRetries": { diff --git a/googleapiclient/discovery_cache/documents/notebooks.v1.json b/googleapiclient/discovery_cache/documents/notebooks.v1.json index 9db18ee9a05..3dd394be674 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v1.json +++ b/googleapiclient/discovery_cache/documents/notebooks.v1.json @@ -2008,7 +2008,7 @@ } } }, -"revision": "20240613", +"revision": "20240820", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2035,6 +2035,8 @@ "NVIDIA_TESLA_T4_VWS", "NVIDIA_TESLA_P100_VWS", "NVIDIA_TESLA_P4_VWS", +"NVIDIA_H100_80GB", +"NVIDIA_H100_MEGA_80GB", "TPU_V2", "TPU_V3" ], @@ -2051,6 +2053,8 @@ "Accelerator type is NVIDIA Tesla T4 Virtual Workstations.", "Accelerator type is NVIDIA Tesla P100 Virtual Workstations.", "Accelerator type is NVIDIA Tesla P4 Virtual Workstations.", +"Accelerator type is NVIDIA H100 80GB.", +"Accelerator type is NVIDIA H100 Mega 80GB.", "(Coming soon) Accelerator type is TPU V2.", "(Coming soon) Accelerator type is TPU V3." ], @@ -4058,6 +4062,8 @@ false "NVIDIA_TESLA_T4_VWS", "NVIDIA_TESLA_P100_VWS", "NVIDIA_TESLA_P4_VWS", +"NVIDIA_H100_80GB", +"NVIDIA_H100_MEGA_80GB", "TPU_V2", "TPU_V3" ], @@ -4074,6 +4080,8 @@ false "Accelerator type is NVIDIA Tesla T4 Virtual Workstations.", "Accelerator type is NVIDIA Tesla P100 Virtual Workstations.", "Accelerator type is NVIDIA Tesla P4 Virtual Workstations.", +"Accelerator type is NVIDIA H100 80GB.", +"Accelerator type is NVIDIA H100 Mega 80GB.", "(Coming soon) Accelerator type is TPU V2.", "(Coming soon) Accelerator type is TPU V3." ], diff --git a/googleapiclient/discovery_cache/documents/notebooks.v2.json b/googleapiclient/discovery_cache/documents/notebooks.v2.json index 6f6c3e26219..bb705da5078 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v2.json +++ b/googleapiclient/discovery_cache/documents/notebooks.v2.json @@ -550,6 +550,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"restore": { +"description": "RestoreInstance restores an Instance from a BackupSource.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:restore", +"httpMethod": "POST", +"id": "notebooks.projects.locations.instances.restore", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}:restore", +"request": { +"$ref": "RestoreInstanceRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "rollback": { "description": "Rollbacks a notebook instance to the previous version.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:rollback", @@ -876,7 +904,7 @@ } } }, -"revision": "20240731", +"revision": "20240820", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1768,6 +1796,17 @@ }, "type": "object" }, +"RestoreInstanceRequest": { +"description": "Request for restoring the notebook instance from a BackupSource.", +"id": "RestoreInstanceRequest", +"properties": { +"snapshot": { +"$ref": "Snapshot", +"description": "Snapshot to be used for restore." +} +}, +"type": "object" +}, "RollbackInstanceRequest": { "description": "Request for rollbacking a notebook instance", "id": "RollbackInstanceRequest", @@ -1833,6 +1872,21 @@ }, "type": "object" }, +"Snapshot": { +"description": "Snapshot represents the snapshot of the data disk used to restore the Workbench Instance from. Refers to: compute/v1/projects/{project_id}/global/snapshots/{snapshot_id}", +"id": "Snapshot", +"properties": { +"projectId": { +"description": "Required. The project ID of the snapshot.", +"type": "string" +}, +"snapshotId": { +"description": "Required. The ID of the snapshot.", +"type": "string" +} +}, +"type": "object" +}, "StartInstanceRequest": { "description": "Request for starting a notebook instance", "id": "StartInstanceRequest", diff --git a/googleapiclient/discovery_cache/documents/pollen.v1.json b/googleapiclient/discovery_cache/documents/pollen.v1.json index db43cff4afc..a6ff737f141 100644 --- a/googleapiclient/discovery_cache/documents/pollen.v1.json +++ b/googleapiclient/discovery_cache/documents/pollen.v1.json @@ -233,7 +233,7 @@ } } }, -"revision": "20240720", +"revision": "20240825", "rootUrl": "https://pollen.googleapis.com/", "schemas": { "Color": { @@ -471,7 +471,9 @@ "HAZEL", "GRAMINALES", "RAGWEED", -"MUGWORT" +"MUGWORT", +"JAPANESE_CEDAR", +"JAPANESE_CYPRESS" ], "enumDescriptions": [ "Unspecified plant code.", @@ -489,7 +491,9 @@ "Hazel is classified as a tree pollen type.", "Graminales is classified as a grass pollen type.", "Ragweed is classified as a weed pollen type.", -"Mugwort is classified as a weed pollen type." +"Mugwort is classified as a weed pollen type.", +"Japanese cedar is classified as a tree pollen type.", +"Japanese cypress is classified as a tree pollen type." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/privateca.v1.json b/googleapiclient/discovery_cache/documents/privateca.v1.json index b426c8b957a..658a5f0fb95 100644 --- a/googleapiclient/discovery_cache/documents/privateca.v1.json +++ b/googleapiclient/discovery_cache/documents/privateca.v1.json @@ -1605,7 +1605,7 @@ } } }, -"revision": "20240626", +"revision": "20240819", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AccessUrls": { @@ -2113,6 +2113,10 @@ "$ref": "KeyId", "description": "Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2." }, +"tbsCertificateDigest": { +"description": "The hash of the pre-signed certificate, which will be signed by the CA. Corresponds to the TBS Certificate in https://tools.ietf.org/html/rfc5280#section-4.1.2. The field will always be populated.", +"type": "string" +}, "x509Description": { "$ref": "X509Parameters", "description": "Describes some of the technical X.509 fields in a certificate." diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index 1539b701532..6e2c5823f7e 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -371,6 +371,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"rescheduleClusterMaintenance": { +"description": "Reschedules upcoming maintenance event.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:rescheduleClusterMaintenance", +"httpMethod": "POST", +"id": "redis.projects.locations.clusters.rescheduleClusterMaintenance", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Redis Cluster instance resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:rescheduleClusterMaintenance", +"request": { +"$ref": "RescheduleClusterMaintenanceRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -821,7 +849,7 @@ } } }, -"revision": "20240812", +"revision": "20240822", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -840,7 +868,7 @@ "Not set. Default: EVERYSEC", "Never fsync. Normally Linux will flush data every 30 seconds with this configuration, but it's up to the kernel's exact tuning.", "fsync every second. Fast enough, and you may lose 1 second of data if there is a disaster", -"fsync every time new commands are appended to the AOF. It has the best data loss protection at the cost of performance" +"fsync every time new write commands are appended to the AOF. It has the best data loss protection at the cost of performance" ], "type": "string" } @@ -851,6 +879,10 @@ "description": "Configuration for availability of database instance", "id": "AvailabilityConfiguration", "properties": { +"automaticFailoverRoutingConfigured": { +"description": "Checks for existence of (multi-cluster) routing configuration that allows automatic failover to a different zone/region in case of an outage. Applicable to Bigtable resources.", +"type": "boolean" +}, "availabilityType": { "description": "Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data accessibility. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available).", "enum": [ @@ -1003,6 +1035,15 @@ "readOnly": true, "type": "array" }, +"maintenancePolicy": { +"$ref": "ClusterMaintenancePolicy", +"description": "Optional. ClusterMaintenancePolicy determines when to allow or deny updates." +}, +"maintenanceSchedule": { +"$ref": "ClusterMaintenanceSchedule", +"description": "Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.", +"readOnly": true +}, "name": { "description": "Required. Identifier. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`", "type": "string" @@ -1123,6 +1164,57 @@ }, "type": "object" }, +"ClusterMaintenancePolicy": { +"description": "Maintenance policy per cluster.", +"id": "ClusterMaintenancePolicy", +"properties": { +"createTime": { +"description": "Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"weeklyMaintenanceWindow": { +"description": "Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_window is expected to be one.", +"items": { +"$ref": "ClusterWeeklyMaintenanceWindow" +}, +"type": "array" +} +}, +"type": "object" +}, +"ClusterMaintenanceSchedule": { +"description": "Upcoming maitenance schedule.", +"id": "ClusterMaintenanceSchedule", +"properties": { +"endTime": { +"description": "Output only. The end time of any upcoming scheduled maintenance for this instance.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"scheduleDeadlineTime": { +"description": "Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"startTime": { +"description": "Output only. The start time of any upcoming scheduled maintenance for this instance.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ClusterPersistenceConfig": { "description": "Configuration of the persistence functionality.", "id": "ClusterPersistenceConfig", @@ -1154,6 +1246,46 @@ }, "type": "object" }, +"ClusterWeeklyMaintenanceWindow": { +"description": "Time window specified for weekly operations.", +"id": "ClusterWeeklyMaintenanceWindow", +"properties": { +"day": { +"description": "Allows to define schedule that runs specified day of the week.", +"enum": [ +"DAY_OF_WEEK_UNSPECIFIED", +"MONDAY", +"TUESDAY", +"WEDNESDAY", +"THURSDAY", +"FRIDAY", +"SATURDAY", +"SUNDAY" +], +"enumDescriptions": [ +"The day of the week is unspecified.", +"Monday", +"Tuesday", +"Wednesday", +"Thursday", +"Friday", +"Saturday", +"Sunday" +], +"type": "string" +}, +"duration": { +"description": "Duration of the time window.", +"format": "google-duration", +"type": "string" +}, +"startTime": { +"$ref": "TimeOfDay", +"description": "Start time of the window in UTC." +} +}, +"type": "object" +}, "Compliance": { "description": "Contains compliance information about a security standard indicating unmet recommendations.", "id": "Compliance", @@ -3351,6 +3483,32 @@ false }, "type": "object" }, +"RescheduleClusterMaintenanceRequest": { +"description": "Request for rescheduling a cluster maintenance.", +"id": "RescheduleClusterMaintenanceRequest", +"properties": { +"rescheduleType": { +"description": "Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.", +"enum": [ +"RESCHEDULE_TYPE_UNSPECIFIED", +"IMMEDIATE", +"SPECIFIC_TIME" +], +"enumDescriptions": [ +"Not set.", +"If the user wants to schedule the maintenance to happen now.", +"If the user wants to reschedule the maintenance to a specific time." +], +"type": "string" +}, +"scheduleTime": { +"description": "Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example `2012-11-15T16:19:00.094Z`.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "RescheduleMaintenanceRequest": { "description": "Request for RescheduleMaintenance.", "id": "RescheduleMaintenanceRequest", diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index dcbd315705a..a0db65ba31a 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -371,6 +371,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"rescheduleClusterMaintenance": { +"description": "Reschedules upcoming maintenance event.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:rescheduleClusterMaintenance", +"httpMethod": "POST", +"id": "redis.projects.locations.clusters.rescheduleClusterMaintenance", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Redis Cluster instance resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:rescheduleClusterMaintenance", +"request": { +"$ref": "RescheduleClusterMaintenanceRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -821,7 +849,7 @@ } } }, -"revision": "20240812", +"revision": "20240822", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -840,7 +868,7 @@ "Not set. Default: EVERYSEC", "Never fsync. Normally Linux will flush data every 30 seconds with this configuration, but it's up to the kernel's exact tuning.", "fsync every second. Fast enough, and you may lose 1 second of data if there is a disaster", -"fsync every time new commands are appended to the AOF. It has the best data loss protection at the cost of performance" +"fsync every time new write commands are appended to the AOF. It has the best data loss protection at the cost of performance" ], "type": "string" } @@ -851,6 +879,10 @@ "description": "Configuration for availability of database instance", "id": "AvailabilityConfiguration", "properties": { +"automaticFailoverRoutingConfigured": { +"description": "Checks for existence of (multi-cluster) routing configuration that allows automatic failover to a different zone/region in case of an outage. Applicable to Bigtable resources.", +"type": "boolean" +}, "availabilityType": { "description": "Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data accessibility. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available).", "enum": [ @@ -1003,6 +1035,15 @@ "readOnly": true, "type": "array" }, +"maintenancePolicy": { +"$ref": "ClusterMaintenancePolicy", +"description": "Optional. ClusterMaintenancePolicy determines when to allow or deny updates." +}, +"maintenanceSchedule": { +"$ref": "ClusterMaintenanceSchedule", +"description": "Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.", +"readOnly": true +}, "name": { "description": "Required. Identifier. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`", "type": "string" @@ -1123,6 +1164,57 @@ }, "type": "object" }, +"ClusterMaintenancePolicy": { +"description": "Maintenance policy per cluster.", +"id": "ClusterMaintenancePolicy", +"properties": { +"createTime": { +"description": "Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"weeklyMaintenanceWindow": { +"description": "Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_window is expected to be one.", +"items": { +"$ref": "ClusterWeeklyMaintenanceWindow" +}, +"type": "array" +} +}, +"type": "object" +}, +"ClusterMaintenanceSchedule": { +"description": "Upcoming maitenance schedule.", +"id": "ClusterMaintenanceSchedule", +"properties": { +"endTime": { +"description": "Output only. The end time of any upcoming scheduled maintenance for this instance.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"scheduleDeadlineTime": { +"description": "Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"startTime": { +"description": "Output only. The start time of any upcoming scheduled maintenance for this instance.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ClusterPersistenceConfig": { "description": "Configuration of the persistence functionality.", "id": "ClusterPersistenceConfig", @@ -1154,6 +1246,46 @@ }, "type": "object" }, +"ClusterWeeklyMaintenanceWindow": { +"description": "Time window specified for weekly operations.", +"id": "ClusterWeeklyMaintenanceWindow", +"properties": { +"day": { +"description": "Allows to define schedule that runs specified day of the week.", +"enum": [ +"DAY_OF_WEEK_UNSPECIFIED", +"MONDAY", +"TUESDAY", +"WEDNESDAY", +"THURSDAY", +"FRIDAY", +"SATURDAY", +"SUNDAY" +], +"enumDescriptions": [ +"The day of the week is unspecified.", +"Monday", +"Tuesday", +"Wednesday", +"Thursday", +"Friday", +"Saturday", +"Sunday" +], +"type": "string" +}, +"duration": { +"description": "Duration of the time window.", +"format": "google-duration", +"type": "string" +}, +"startTime": { +"$ref": "TimeOfDay", +"description": "Start time of the window in UTC." +} +}, +"type": "object" +}, "Compliance": { "description": "Contains compliance information about a security standard indicating unmet recommendations.", "id": "Compliance", @@ -3358,6 +3490,32 @@ false }, "type": "object" }, +"RescheduleClusterMaintenanceRequest": { +"description": "Request for rescheduling a cluster maintenance.", +"id": "RescheduleClusterMaintenanceRequest", +"properties": { +"rescheduleType": { +"description": "Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.", +"enum": [ +"RESCHEDULE_TYPE_UNSPECIFIED", +"IMMEDIATE", +"SPECIFIC_TIME" +], +"enumDescriptions": [ +"Not set.", +"If the user wants to schedule the maintenance to happen now.", +"If the user wants to reschedule the maintenance to a specific time." +], +"type": "string" +}, +"scheduleTime": { +"description": "Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example `2012-11-15T16:19:00.094Z`.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "RescheduleMaintenanceRequest": { "description": "Request for RescheduleMaintenance.", "id": "RescheduleMaintenanceRequest", diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index f1a225531b9..2249532693c 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -1526,7 +1526,7 @@ } } }, -"revision": "20240809", +"revision": "20240816", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -3367,6 +3367,14 @@ "description": "Output only. The main URI in which this Service is serving traffic.", "readOnly": true, "type": "string" +}, +"urls": { +"description": "Output only. All URLs serving traffic for this Service.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/searchads360.v0.json b/googleapiclient/discovery_cache/documents/searchads360.v0.json index 99c262bad08..61703f93d09 100644 --- a/googleapiclient/discovery_cache/documents/searchads360.v0.json +++ b/googleapiclient/discovery_cache/documents/searchads360.v0.json @@ -260,7 +260,7 @@ } } }, -"revision": "20240808", +"revision": "20240822", "rootUrl": "https://searchads360.googleapis.com/", "schemas": { "GoogleAdsSearchads360V0Common__AdScheduleInfo": { @@ -4320,6 +4320,12 @@ false "description": "Immutable. The label assigned to the ad group ad.", "type": "string" }, +"ownerCustomerId": { +"description": "Output only. The ID of the Customer which owns the label.", +"format": "int64", +"readOnly": true, +"type": "string" +}, "resourceName": { "description": "Immutable. The resource name of the ad group ad label. Ad group ad label resource names have the form: `customers/{customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}~{label_id}`", "type": "string" @@ -4742,6 +4748,12 @@ false "description": "Immutable. The label assigned to the ad group criterion.", "type": "string" }, +"ownerCustomerId": { +"description": "Output only. The ID of the Customer which owns the label.", +"format": "int64", +"readOnly": true, +"type": "string" +}, "resourceName": { "description": "Immutable. The resource name of the ad group criterion label. Ad group criterion label resource names have the form: `customers/{customer_id}/adGroupCriterionLabels/{ad_group_id}~{criterion_id}~{label_id}`", "type": "string" @@ -4761,6 +4773,12 @@ false "description": "Immutable. The label assigned to the ad group.", "type": "string" }, +"ownerCustomerId": { +"description": "Output only. The ID of the Customer which owns the label.", +"format": "int64", +"readOnly": true, +"type": "string" +}, "resourceName": { "description": "Immutable. The resource name of the ad group label. Ad group label resource names have the form: `customers/{customer_id}/adGroupLabels/{ad_group_id}~{label_id}`", "type": "string" @@ -6345,6 +6363,12 @@ false "description": "Immutable. The label assigned to the campaign.", "type": "string" }, +"ownerCustomerId": { +"description": "Output only. The ID of the Customer which owns the label.", +"format": "int64", +"readOnly": true, +"type": "string" +}, "resourceName": { "description": "Immutable. Name of the resource. Campaign label resource names have the form: `customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}`", "type": "string" @@ -7036,6 +7060,31 @@ false "readOnly": true, "type": "boolean" }, +"renderType": { +"description": "Output only. How the result value of the custom column should be interpreted.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"NUMBER", +"PERCENT", +"MONEY", +"STRING", +"BOOLEAN", +"DATE" +], +"enumDescriptions": [ +"Not specified.", +"Unknown.", +"The custom column is a raw numerical value. See value_type field to determine if it is an integer or a double.", +"The custom column should be multiplied by 100 to retrieve the percentage value.", +"The custom column value is a monetary value and is in micros.", +"The custom column value is a string.", +"The custom column value is a boolean.", +"The custom column value is a date represented as an integer in YYYYMMDD format." +], +"readOnly": true, +"type": "string" +}, "resourceName": { "description": "Immutable. The resource name of the custom column. Custom column resource names have the form: `customers/{customer_id}/customColumns/{custom_column_id}`", "type": "string" @@ -7048,7 +7097,8 @@ false "STRING", "INT64", "DOUBLE", -"BOOLEAN" +"BOOLEAN", +"DATE" ], "enumDescriptions": [ "Not specified.", @@ -7056,7 +7106,8 @@ false "The custom column value is a string.", "The custom column value is an int64 number.", "The custom column value is a double number.", -"The custom column value is a boolean." +"The custom column value is a boolean.", +"The custom column value is a date, in YYYYMMDD format." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1.json index 4286e42fe1b..2dbc392f590 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1.json @@ -1190,7 +1190,7 @@ } } }, -"revision": "20240726", +"revision": "20240816", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { @@ -1814,7 +1814,7 @@ "id": "Topic", "properties": { "name": { -"description": "Required. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission.", +"description": "Identifier. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role (`roles/pubsub.publisher`) includes this permission.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json index d18d247b207..0cbcf4c213d 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json @@ -1029,7 +1029,7 @@ } } }, -"revision": "20240716", +"revision": "20240820", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1211,6 +1211,10 @@ }, "type": "array" }, +"skipRequestedAddressValidation": { +"description": "Optional. Skips validating if the requested_address is in use by SN VPC\u2019s peering group. Compute Engine will still perform this check and fail the request if the requested_address is in use. Note that Compute Engine does not check for the existence of dynamic routes when performing this check. Caller of this API should make sure that there are no dynamic routes overlapping with the requested_address/prefix_length IP address range otherwise the created subnet could cause misrouting.", +"type": "boolean" +}, "subnetwork": { "description": "Required. A name for the new subnet. For information about the naming requirements, see [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the Compute API documentation.", "type": "string" @@ -3219,7 +3223,7 @@ "type": "string" }, "role": { -"description": "Required. Role to apply. Only allowlisted roles can be used at the specified granularity. The role must be one of the following: - 'roles/container.hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute.securityAdmin' applied on the shared VPC host project - 'roles/compute.networkAdmin' applied on the shared VPC host project - 'roles/compute.xpnAdmin' applied on the shared VPC host project - 'roles/dns.admin' applied on the shared VPC host project - 'roles/logging.admin' applied on the shared VPC host project", +"description": "Required. Role to apply. Only allowlisted roles can be used at the specified granularity. The role must be one of the following: - 'roles/container.hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute.securityAdmin' applied on the shared VPC host project - 'roles/compute.networkAdmin' applied on the shared VPC host project - 'roles/tpu.xpnAgent' applied on the shared VPC host project - 'roles/dns.admin' applied on the shared VPC host project - 'roles/logging.admin' applied on the shared VPC host project - 'roles/monitoring.viewer' applied on the shared VPC host project", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json index 18bd3a50dc7..7d2b4ac60a9 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json @@ -307,7 +307,7 @@ } } }, -"revision": "20240716", +"revision": "20240820", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -2243,7 +2243,7 @@ "type": "string" }, "role": { -"description": "Required. Role to apply. Only allowlisted roles can be used at the specified granularity. The role must be one of the following: - 'roles/container.hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute.securityAdmin' applied on the shared VPC host project - 'roles/compute.networkAdmin' applied on the shared VPC host project - 'roles/compute.xpnAdmin' applied on the shared VPC host project - 'roles/dns.admin' applied on the shared VPC host project - 'roles/logging.admin' applied on the shared VPC host project", +"description": "Required. Role to apply. Only allowlisted roles can be used at the specified granularity. The role must be one of the following: - 'roles/container.hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute.securityAdmin' applied on the shared VPC host project - 'roles/compute.networkAdmin' applied on the shared VPC host project - 'roles/tpu.xpnAgent' applied on the shared VPC host project - 'roles/dns.admin' applied on the shared VPC host project - 'roles/logging.admin' applied on the shared VPC host project - 'roles/monitoring.viewer' applied on the shared VPC host project", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/solar.v1.json b/googleapiclient/discovery_cache/documents/solar.v1.json index 516fc84edd9..34279cf09a3 100644 --- a/googleapiclient/discovery_cache/documents/solar.v1.json +++ b/googleapiclient/discovery_cache/documents/solar.v1.json @@ -114,6 +114,20 @@ "id": "solar.buildingInsights.findClosest", "parameterOrder": [], "parameters": { +"experiments": { +"description": "Optional. Specifies the pre-GA features to enable.", +"enum": [ +"EXPERIMENT_UNSPECIFIED", +"EXPANDED_COVERAGE" +], +"enumDescriptions": [ +"No experiments are specified.", +"Expands the geographic region available for querying solar data." +], +"location": "query", +"repeated": true, +"type": "string" +}, "location.latitude": { "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", "format": "double", @@ -132,12 +146,14 @@ "IMAGERY_QUALITY_UNSPECIFIED", "HIGH", "MEDIUM", -"LOW" +"LOW", +"BASE" ], "enumDescriptions": [ "No quality is known.", "Solar data is derived from aerial imagery captured at low-altitude and processed at 0.1 m/pixel.", "Solar data is derived from enhanced aerial imagery captured at high-altitude and processed at 0.25 m/pixel.", +"Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel.", "Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel." ], "location": "query", @@ -168,6 +184,20 @@ "location": "query", "type": "boolean" }, +"experiments": { +"description": "Optional. Specifies the pre-GA experiments to enable.", +"enum": [ +"EXPERIMENT_UNSPECIFIED", +"EXPANDED_COVERAGE" +], +"enumDescriptions": [ +"No experiments are specified.", +"Expands the geographic region available for querying solar data." +], +"location": "query", +"repeated": true, +"type": "string" +}, "location.latitude": { "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", "format": "double", @@ -198,12 +228,14 @@ "IMAGERY_QUALITY_UNSPECIFIED", "HIGH", "MEDIUM", -"LOW" +"LOW", +"BASE" ], "enumDescriptions": [ "No quality is known.", "Solar data is derived from aerial imagery captured at low-altitude and processed at 0.1 m/pixel.", "Solar data is derived from enhanced aerial imagery captured at high-altitude and processed at 0.25 m/pixel.", +"Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel.", "Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel." ], "location": "query", @@ -267,7 +299,7 @@ } } }, -"revision": "20240707", +"revision": "20240820", "rootUrl": "https://solar.googleapis.com/", "schemas": { "BuildingInsights": { @@ -300,12 +332,14 @@ "IMAGERY_QUALITY_UNSPECIFIED", "HIGH", "MEDIUM", -"LOW" +"LOW", +"BASE" ], "enumDescriptions": [ "No quality is known.", "Solar data is derived from aerial imagery captured at low-altitude and processed at 0.1 m/pixel.", "Solar data is derived from enhanced aerial imagery captured at high-altitude and processed at 0.25 m/pixel.", +"Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel.", "Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel." ], "type": "string" @@ -394,12 +428,14 @@ "IMAGERY_QUALITY_UNSPECIFIED", "HIGH", "MEDIUM", -"LOW" +"LOW", +"BASE" ], "enumDescriptions": [ "No quality is known.", "Solar data is derived from aerial imagery captured at low-altitude and processed at 0.1 m/pixel.", "Solar data is derived from enhanced aerial imagery captured at high-altitude and processed at 0.25 m/pixel.", +"Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel.", "Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel." ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/spanner.v1.json b/googleapiclient/discovery_cache/documents/spanner.v1.json index d656f5371e2..74b1fa01b06 100644 --- a/googleapiclient/discovery_cache/documents/spanner.v1.json +++ b/googleapiclient/discovery_cache/documents/spanner.v1.json @@ -1100,7 +1100,7 @@ ], "parameters": { "filter": { -"description": "An expression that filters the list of returned backups. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Backup are eligible for filtering: * `name` * `database` * `state` * `create_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `version_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `size_bytes` You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `name:Howl` - The backup's name contains the string \"howl\". * `database:prod` - The database's name contains the string \"prod\". * `state:CREATING` - The backup is pending creation. * `state:READY` - The backup is fully created and ready for use. * `(name:howl) AND (create_time < \\\"2018-03-28T14:50:00Z\\\")` - The backup name contains the string \"howl\" and `create_time` of the backup is before 2018-03-28T14:50:00Z. * `expire_time < \\\"2018-03-28T14:50:00Z\\\"` - The backup `expire_time` is before 2018-03-28T14:50:00Z. * `size_bytes > 10000000000` - The backup's size is greater than 10GB", +"description": "An expression that filters the list of returned backups. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Backup are eligible for filtering: * `name` * `database` * `state` * `create_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `version_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `size_bytes` * `backup_schedules` You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `name:Howl` - The backup's name contains the string \"howl\". * `database:prod` - The database's name contains the string \"prod\". * `state:CREATING` - The backup is pending creation. * `state:READY` - The backup is fully created and ready for use. * `(name:howl) AND (create_time < \\\"2018-03-28T14:50:00Z\\\")` - The backup name contains the string \"howl\" and `create_time` of the backup is before 2018-03-28T14:50:00Z. * `expire_time < \\\"2018-03-28T14:50:00Z\\\"` - The backup `expire_time` is before 2018-03-28T14:50:00Z. * `size_bytes > 10000000000` - The backup's size is greater than 10GB * `backup_schedules:daily` - The backup is created from a schedule with \"daily\" in its name.", "location": "query", "type": "string" }, @@ -3259,7 +3259,7 @@ } } }, -"revision": "20240807", +"revision": "20240814", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "AutoscalingConfig": { diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1.json b/googleapiclient/discovery_cache/documents/sqladmin.v1.json index 5cc9c19567c..c9444eea35d 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1.json @@ -2267,7 +2267,7 @@ } } }, -"revision": "20240724", +"revision": "20240814", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2720,6 +2720,10 @@ "format": "google-datetime", "type": "string" }, +"preferredSecondaryZone": { +"description": "Optional. Copy clone and point-in-time recovery clone of a regional instance in the specified zones. If not specified, clone to the same secondary zone as the source instance. This value cannot be the same as the preferred_zone field. This field applies to all DB types.", +"type": "string" +}, "preferredZone": { "description": "Optional. Copy clone and point-in-time recovery clone of an instance to the specified zone. If no zone is specified, clone to the same primary zone as the source instance. This field applies to all DB types.", "type": "string" @@ -2791,7 +2795,6 @@ false "MYSQL_8_0_39", "MYSQL_8_0_40", "MYSQL_8_4", -"MYSQL_8_4_0", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -2844,7 +2847,6 @@ false, false, false, false, -false, false ], "enumDescriptions": [ @@ -2883,7 +2885,6 @@ false "The database major version is MySQL 8.0 and the minor version is 39.", "The database major version is MySQL 8.0 and the minor version is 40.", "The database version is MySQL 8.4.", -"The database version is MySQL 8.4 and the patch version is 0.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -3100,7 +3101,6 @@ false "MYSQL_8_0_39", "MYSQL_8_0_40", "MYSQL_8_4", -"MYSQL_8_4_0", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -3153,7 +3153,6 @@ false, false, false, false, -false, false ], "enumDescriptions": [ @@ -3192,7 +3191,6 @@ false "The database major version is MySQL 8.0 and the minor version is 39.", "The database major version is MySQL 8.0 and the minor version is 40.", "The database version is MySQL 8.4.", -"The database version is MySQL 8.4 and the patch version is 0.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -3854,7 +3852,6 @@ true "MYSQL_8_0_39", "MYSQL_8_0_40", "MYSQL_8_4", -"MYSQL_8_4_0", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -3907,7 +3904,6 @@ false, false, false, false, -false, false ], "enumDescriptions": [ @@ -3946,7 +3942,6 @@ false "The database major version is MySQL 8.0 and the minor version is 39.", "The database major version is MySQL 8.0 and the minor version is 40.", "The database version is MySQL 8.4.", -"The database version is MySQL 8.4 and the patch version is 0.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -6293,9 +6288,9 @@ true "The database's built-in user type.", "Cloud IAM user.", "Cloud IAM service account.", -"Cloud IAM group non-login user.", -"Cloud IAM group login user.", -"Cloud IAM group login service account." +"Cloud IAM group. Not used for login.", +"Read-only. Login for a user that belongs to the Cloud IAM group.", +"Read-only. Login for a service account that belongs to the Cloud IAM group." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json index 7fd82684d4d..10753b34e07 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json @@ -2267,7 +2267,7 @@ } } }, -"revision": "20240724", +"revision": "20240814", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2720,6 +2720,10 @@ "format": "google-datetime", "type": "string" }, +"preferredSecondaryZone": { +"description": "Optional. Copy clone and point-in-time recovery clone of a regional instance in the specified zones. If not specified, clone to the same secondary zone as the source instance. This value cannot be the same as the preferred_zone field.", +"type": "string" +}, "preferredZone": { "description": "Optional. Copy clone and point-in-time recovery clone of an instance to the specified zone. If no zone is specified, clone to the same primary zone as the source instance.", "type": "string" @@ -2791,7 +2795,6 @@ false "MYSQL_8_0_39", "MYSQL_8_0_40", "MYSQL_8_4", -"MYSQL_8_4_0", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -2844,7 +2847,6 @@ false, false, false, false, -false, false ], "enumDescriptions": [ @@ -2883,7 +2885,6 @@ false "The database major version is MySQL 8.0 and the minor version is 39.", "The database major version is MySQL 8.0 and the minor version is 40.", "The database version is MySQL 8.4.", -"The database version is MySQL 8.4 and the patch version is 0.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -3100,7 +3101,6 @@ false "MYSQL_8_0_39", "MYSQL_8_0_40", "MYSQL_8_4", -"MYSQL_8_4_0", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -3153,7 +3153,6 @@ false, false, false, false, -false, false ], "enumDescriptions": [ @@ -3192,7 +3191,6 @@ false "The database major version is MySQL 8.0 and the minor version is 39.", "The database major version is MySQL 8.0 and the minor version is 40.", "The database version is MySQL 8.4.", -"The database version is MySQL 8.4 and the patch version is 0.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -3855,7 +3853,6 @@ true "MYSQL_8_0_39", "MYSQL_8_0_40", "MYSQL_8_4", -"MYSQL_8_4_0", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", @@ -3908,7 +3905,6 @@ false, false, false, false, -false, false ], "enumDescriptions": [ @@ -3947,7 +3943,6 @@ false "The database major version is MySQL 8.0 and the minor version is 39.", "The database major version is MySQL 8.0 and the minor version is 40.", "The database version is MySQL 8.4.", -"The database version is MySQL 8.4 and the patch version is 0.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -6292,9 +6287,9 @@ true "The database's built-in user type.", "Cloud IAM user.", "Cloud IAM service account.", -"Cloud IAM group non-login user.", -"Cloud IAM group login user.", -"Cloud IAM group service account." +"Cloud IAM group. Not used for login.", +"Read-only. Login for a user that belongs to the Cloud IAM group.", +"Read-only. Login for a service account that belongs to the Cloud IAM group." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/storage.v1.json b/googleapiclient/discovery_cache/documents/storage.v1.json index 4a240a580fc..d09b27f3f17 100644 --- a/googleapiclient/discovery_cache/documents/storage.v1.json +++ b/googleapiclient/discovery_cache/documents/storage.v1.json @@ -43,7 +43,7 @@ "location": "me-central2" } ], -"etag": "\"34373939373134303235393739323331393435\"", +"etag": "\"38363036373236373330353534313035333932\"", "icons": { "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png", "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png" @@ -4136,7 +4136,7 @@ } } }, -"revision": "20240809", +"revision": "20240819", "rootUrl": "https://storage.googleapis.com/", "schemas": { "AnywhereCache": { @@ -4349,6 +4349,11 @@ "format": "int64", "type": "string" }, +"hardDeleteTime": { +"description": "The hard delete time of the bucket in RFC 3339 format.", +"format": "date-time", +"type": "string" +}, "hierarchicalNamespace": { "description": "The bucket's hierarchical namespace configuration.", "properties": { @@ -4675,6 +4680,11 @@ }, "type": "object" }, +"softDeleteTime": { +"description": "The soft delete time of the bucket in RFC 3339 format.", +"format": "date-time", +"type": "string" +}, "storageClass": { "description": "The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see [Storage Classes](https://cloud.google.com/storage/docs/storage-classes).", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1.json index 8bc4f6238ff..26a37ba4f28 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1.json @@ -318,7 +318,7 @@ } } }, -"revision": "20240530", +"revision": "20240815", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AudioConfig": { @@ -578,7 +578,7 @@ }, "input": { "$ref": "SynthesisInput", -"description": "Required. The Synthesizer requires either plain text or SSML as input. While Long Audio is in preview, SSML is temporarily unsupported." +"description": "Required. The Synthesizer requires either plain text or SSML as input." }, "outputGcsUri": { "description": "Required. Specifies a Cloud Storage URI for the synthesis results. Must be specified in the format: `gs://bucket_name/object_name`, and the bucket must already exist.", diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json index fa5dd27ef82..49423163da4 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json @@ -261,7 +261,7 @@ } } }, -"revision": "20240530", +"revision": "20240815", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AudioConfig": { @@ -511,7 +511,7 @@ }, "input": { "$ref": "SynthesisInput", -"description": "Required. The Synthesizer requires either plain text or SSML as input. While Long Audio is in preview, SSML is temporarily unsupported." +"description": "Required. The Synthesizer requires either plain text or SSML as input." }, "outputGcsUri": { "description": "Required. Specifies a Cloud Storage URI for the synthesis results. Must be specified in the format: `gs://bucket_name/object_name`, and the bucket must already exist.", diff --git a/googleapiclient/discovery_cache/documents/translate.v3.json b/googleapiclient/discovery_cache/documents/translate.v3.json index 57fae60cd57..efcb0402581 100644 --- a/googleapiclient/discovery_cache/documents/translate.v3.json +++ b/googleapiclient/discovery_cache/documents/translate.v3.json @@ -1396,7 +1396,7 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the entry. Format: \"projects/*/locations/*/glossaries/*/glossaryEntries/*\"", +"description": "Identifier. The resource name of the entry. Format: `projects/*/locations/*/glossaries/*/glossaryEntries/*`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/glossaryEntries/[^/]+$", "required": true, @@ -1707,7 +1707,7 @@ } } }, -"revision": "20240718", +"revision": "20240821", "rootUrl": "https://translation.googleapis.com/", "schemas": { "AdaptiveMtDataset": { @@ -1829,7 +1829,7 @@ "type": "string" }, "glossaryConfig": { -"$ref": "TranslateTextGlossaryConfig", +"$ref": "GlossaryConfig", "description": "Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned." }, "referenceSentenceConfig": { @@ -2227,7 +2227,7 @@ "id": "Example", "properties": { "name": { -"description": "Output only. The resource name of the example, in form of `projects/{project-number-or-id}/locations/{location_id}/datasets/{dataset_id}/examples/{example_id}'", +"description": "Output only. The resource name of the example, in form of `projects/{project-number-or-id}/locations/{location_id}/datasets/{dataset_id}/examples/{example_id}`", "readOnly": true, "type": "string" }, @@ -2367,6 +2367,21 @@ }, "type": "object" }, +"GlossaryConfig": { +"description": "Configures which glossary is used for a specific target language and defines options for applying that glossary.", +"id": "GlossaryConfig", +"properties": { +"glossary": { +"description": "Required. The `glossary` to be applied for this translation. The format depends on the glossary: - User-provided custom glossary: `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}`", +"type": "string" +}, +"ignoreCase": { +"description": "Optional. Indicates match is case insensitive. The default value is `false` if missing.", +"type": "boolean" +} +}, +"type": "object" +}, "GlossaryEntry": { "description": "Represents a single entry in a glossary.", "id": "GlossaryEntry", @@ -2376,7 +2391,7 @@ "type": "string" }, "name": { -"description": "Identifier. The resource name of the entry. Format: \"projects/*/locations/*/glossaries/*/glossaryEntries/*\"", +"description": "Identifier. The resource name of the entry. Format: `projects/*/locations/*/glossaries/*/glossaryEntries/*`", "type": "string" }, "termsPair": { diff --git a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json index b47dd7445f0..732663e3b7c 100644 --- a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json +++ b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json @@ -199,6 +199,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"deleteExecutionHistory": { +"description": "Deletes all step entries for an execution.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions/{executionsId}:deleteExecutionHistory", +"httpMethod": "POST", +"id": "workflowexecutions.projects.locations.workflows.executions.deleteExecutionHistory", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the execution for which step entries should be deleted. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+/executions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:deleteExecutionHistory", +"request": { +"$ref": "DeleteExecutionHistoryRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "exportData": { "description": "Returns all metadata stored about an execution, excluding most data that is already accessible using other API methods.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions/{executionsId}:exportData", @@ -384,6 +412,22 @@ "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+/executions/[^/]+/stepEntries/[^/]+$", "required": true, "type": "string" +}, +"view": { +"deprecated": true, +"description": "Deprecated field.", +"enum": [ +"EXECUTION_ENTRY_VIEW_UNSPECIFIED", +"EXECUTION_ENTRY_VIEW_BASIC", +"EXECUTION_ENTRY_VIEW_DETAILED" +], +"enumDescriptions": [ +"The default/unset value.", +"Include basic information in the step entries. All fields in StepEntry are returned except for variable_data.", +"Include all data." +], +"location": "query", +"type": "string" } }, "path": "v1/{+name}", @@ -404,7 +448,7 @@ ], "parameters": { "filter": { -"description": "Optional. Filters applied to the `[StepEntries.ListStepEntries]` results. The following fields are supported for filtering: `entryId`, `createTime`, `updateTime`, `routine`, `step`, `stepType`, `state`. For details, see AIP-160. For example, if you are using the Google APIs Explorer: `state=\"SUCCEEDED\"` or `createTime>\"2023-08-01\" AND state=\"FAILED\"`", +"description": "Optional. Filters applied to the `[StepEntries.ListStepEntries]` results. The following fields are supported for filtering: `entryId`, `createTime`, `updateTime`, `routine`, `step`, `stepType`, `parent`, `state`. For details, see AIP-160. For example, if you are using the Google APIs Explorer: `state=\"SUCCEEDED\"` or `createTime>\"2023-08-01\" AND state=\"FAILED\"`", "location": "query", "type": "string" }, @@ -425,7 +469,7 @@ "type": "string" }, "parent": { -"description": "Required. Name of the workflow execution to list entries for. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/", +"description": "Required. Name of the workflow execution to list entries for. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+/executions/[^/]+$", "required": true, @@ -436,6 +480,22 @@ "format": "int32", "location": "query", "type": "integer" +}, +"view": { +"deprecated": true, +"description": "Deprecated field.", +"enum": [ +"EXECUTION_ENTRY_VIEW_UNSPECIFIED", +"EXECUTION_ENTRY_VIEW_BASIC", +"EXECUTION_ENTRY_VIEW_DETAILED" +], +"enumDescriptions": [ +"The default/unset value.", +"Include basic information in the step entries. All fields in StepEntry are returned except for variable_data.", +"Include all data." +], +"location": "query", +"type": "string" } }, "path": "v1/{+parent}/stepEntries", @@ -457,7 +517,7 @@ } } }, -"revision": "20240715", +"revision": "20240813", "rootUrl": "https://workflowexecutions.googleapis.com/", "schemas": { "Callback": { @@ -497,6 +557,18 @@ "properties": {}, "type": "object" }, +"DeleteExecutionHistoryRequest": { +"description": "Request for the DeleteExecutionHistory method.", +"id": "DeleteExecutionHistoryRequest", +"properties": {}, +"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" +}, "Error": { "description": "Error describes why the execution was abnormally terminated.", "id": "Error", @@ -1012,6 +1084,11 @@ "format": "google-datetime", "readOnly": true, "type": "string" +}, +"variableData": { +"$ref": "VariableData", +"description": "Output only. The VariableData associated to this step.", +"readOnly": true } }, "type": "object" @@ -1080,6 +1157,20 @@ } }, "type": "object" +}, +"VariableData": { +"description": "VariableData contains the variable data for this step.", +"id": "VariableData", +"properties": { +"variables": { +"additionalProperties": { +"type": "any" +}, +"description": "Variables that are associated with this step.", +"type": "object" +} +}, +"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/workflows.v1.json b/googleapiclient/discovery_cache/documents/workflows.v1.json index adae901dbf5..f111259f8e0 100644 --- a/googleapiclient/discovery_cache/documents/workflows.v1.json +++ b/googleapiclient/discovery_cache/documents/workflows.v1.json @@ -485,7 +485,7 @@ } } }, -"revision": "20240710", +"revision": "20240814", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { @@ -776,6 +776,20 @@ "description": "Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision.", "type": "string" }, +"executionHistoryLevel": { +"description": "Optional. Describes the level of the execution history feature to apply to this workflow.", +"enum": [ +"EXECUTION_HISTORY_LEVEL_UNSPECIFIED", +"EXECUTION_HISTORY_BASIC", +"EXECUTION_HISTORY_DETAILED" +], +"enumDescriptions": [ +"The default/unset value.", +"Enable execution history basic feature.", +"Enable execution history detailed feature." +], +"type": "string" +}, "labels": { "additionalProperties": { "type": "string" diff --git a/googleapiclient/discovery_cache/documents/workstations.v1.json b/googleapiclient/discovery_cache/documents/workstations.v1.json index acf58210e1a..1f3fea8575d 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1.json @@ -1195,7 +1195,7 @@ } } }, -"revision": "20240723", +"revision": "20240820", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -2374,6 +2374,10 @@ "description": "Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.", "type": "string" }, +"grantWorkstationAdminRoleOnCreate": { +"description": "Optional. Grant creator of a workstation `roles/workstations.policyAdmin` role along with `roles/workstations.user` role on the workstation created by them. This allows workstation users to share access to either their entire workstation, or individual ports. Defaults to false.", +"type": "boolean" +}, "host": { "$ref": "Host", "description": "Optional. Runtime host for the workstation." @@ -2390,6 +2394,11 @@ "description": "Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.", "type": "object" }, +"maxUsableWorkstations": { +"description": "Optional. Maximum number of workstations under this config a user can have `workstations.workstation.use` permission on. Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by: - granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or - having a user with that permission create a workstation and granting another user `workstations.workstation.use` permission on that workstation. If not specified defaults to 0 which indicates unlimited.", +"format": "int32", +"type": "integer" +}, "name": { "description": "Identifier. Full name of this workstation configuration.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/workstations.v1beta.json b/googleapiclient/discovery_cache/documents/workstations.v1beta.json index d8f5eaea58c..8c53d296b22 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1beta.json @@ -1127,7 +1127,7 @@ } } }, -"revision": "20240803", +"revision": "20240820", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -2356,6 +2356,10 @@ "description": "Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.", "type": "string" }, +"grantWorkstationAdminRoleOnCreate": { +"description": "Optional. Grant creator of a workstation `roles/workstations.policyAdmin` role along with `roles/workstations.user` role on the workstation created by them. This allows workstation users to share access to either their entire workstation, or individual ports. Defaults to false.", +"type": "boolean" +}, "host": { "$ref": "Host", "description": "Optional. Runtime host for the workstation."