diff --git a/docs/dyn/admin_directory_v1.groups.html b/docs/dyn/admin_directory_v1.groups.html index c16965f676..4351ded25c 100644 --- a/docs/dyn/admin_directory_v1.groups.html +++ b/docs/dyn/admin_directory_v1.groups.html @@ -217,7 +217,7 @@

Method Details

Allowed values email - Email of the group. pageToken: string, Token to specify next page in the list - query: string, Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/workspace/admin/directory/v1/guides/search-groups + query: string, Query string search. Contains one or more search clauses, each with a field, operator, and value. For complete documentation, go to [Search for groups](https://developers.google.com/workspace/admin/directory/v1/guides/search-groups). sortOrder: string, Whether to return results in ascending or descending order. Only of use when orderBy is also used Allowed values ASCENDING - Ascending order. diff --git a/docs/dyn/admin_directory_v1.resources.calendars.html b/docs/dyn/admin_directory_v1.resources.calendars.html index 40c59bbe45..4cf9a5da49 100644 --- a/docs/dyn/admin_directory_v1.resources.calendars.html +++ b/docs/dyn/admin_directory_v1.resources.calendars.html @@ -215,7 +215,7 @@

Method Details

maxResults: integer, Maximum number of results to return. orderBy: string, Field(s) to sort results by in either ascending or descending order. Supported fields include `resourceId`, `resourceName`, `capacity`, `buildingId`, and `floorName`. If no order is specified, defaults to ascending. Should be of the form "field [asc|desc], field [asc|desc], ...". For example `buildingId, capacity desc` would return results sorted first by `buildingId` in ascending order then by `capacity` in descending order. pageToken: string, Token to specify the next page in the list. - query: string, String query used to filter results. Should be of the form "field operator value" where field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match, '!=' for mismatch and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a *. Logical operators NOT and AND are supported (in this order of precedence). Supported fields include `generatedResourceName`, `name`, `buildingId`, `floor_name`, `capacity`, `featureInstances.feature.name`, `resourceEmail`, `resourceCategory`. For example `buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone`. + query: string, String query used to filter results. Contains one or more search clauses, each with a field, operator, and value. A field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match, '!=' for mismatch and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a *. Logical operators NOT and AND are supported (in this order of precedence). Supported fields include `generatedResourceName`, `name`, `buildingId`, `floor_name`, `capacity`, `featureInstances.feature.name`, `resourceEmail`, `resourceCategory`. For example `buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone`. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/admin_directory_v1.users.html b/docs/dyn/admin_directory_v1.users.html index ce8adf1701..13220f1a2d 100644 --- a/docs/dyn/admin_directory_v1.users.html +++ b/docs/dyn/admin_directory_v1.users.html @@ -880,7 +880,7 @@

Method Details

basic - Do not include any custom fields for the user. custom - Include custom fields from schemas mentioned in customFieldMask. full - Include all fields associated with this user. - query: string, Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/workspace/admin/directory/v1/guides/search-users + query: string, Query string search. Contains one or more search clauses, each with a field, operator, and value. For complete documentation, go to [Search for users](https://developers.google.com/workspace/admin/directory/v1/guides/search-users). showDeleted: string, If set to true, retrieves the list of deleted users. (Default: false) sortOrder: string, Whether to return results in ascending or descending order. Allowed values diff --git a/docs/dyn/adsense_v2.accounts.reports.html b/docs/dyn/adsense_v2.accounts.reports.html index 38e863c882..a06037aa37 100644 --- a/docs/dyn/adsense_v2.accounts.reports.html +++ b/docs/dyn/adsense_v2.accounts.reports.html @@ -151,6 +151,8 @@

Method Details

PLATFORM_TYPE_CODE - Platform type code (e.g. "HighEndMobile", "Desktop"). TARGETING_TYPE_NAME - Localized targeting type name (e.g. "Contextual", "Personalized", "Run of Network"). TARGETING_TYPE_CODE - Targeting type code (e.g. "Keyword", "UserInterest", "RunOfNetwork"). + TRAFFIC_SOURCE_NAME - Localized traffic source name (e.g. "Google", "Bing", "Facebook", "Other"). For more information, see [Traffic source breakdown](https://support.google.com/adsense/answer/16474600). + TRAFFIC_SOURCE_CODE - Traffic source code (e.g. "GOOGLE", "BING", "FACEBOOK", "OTHER"). For more information, see [Traffic source breakdown](https://support.google.com/adsense/answer/16474600). CONTENT_PLATFORM_NAME - Localized content platform name an ad request was made from (e.g. "AMP", "Web"). CONTENT_PLATFORM_CODE - Content platform code an ad request was made from (e.g. "AMP", "HTML"). AD_PLACEMENT_NAME - Localized ad placement name (e.g. "Ad unit", "Global settings", "Manual"). @@ -329,6 +331,8 @@

Method Details

PLATFORM_TYPE_CODE - Platform type code (e.g. "HighEndMobile", "Desktop"). TARGETING_TYPE_NAME - Localized targeting type name (e.g. "Contextual", "Personalized", "Run of Network"). TARGETING_TYPE_CODE - Targeting type code (e.g. "Keyword", "UserInterest", "RunOfNetwork"). + TRAFFIC_SOURCE_NAME - Localized traffic source name (e.g. "Google", "Bing", "Facebook", "Other"). For more information, see [Traffic source breakdown](https://support.google.com/adsense/answer/16474600). + TRAFFIC_SOURCE_CODE - Traffic source code (e.g. "GOOGLE", "BING", "FACEBOOK", "OTHER"). For more information, see [Traffic source breakdown](https://support.google.com/adsense/answer/16474600). CONTENT_PLATFORM_NAME - Localized content platform name an ad request was made from (e.g. "AMP", "Web"). CONTENT_PLATFORM_CODE - Content platform code an ad request was made from (e.g. "AMP", "HTML"). AD_PLACEMENT_NAME - Localized ad placement name (e.g. "Ad unit", "Global settings", "Manual"). diff --git a/docs/dyn/aiplatform_v1.projects.locations.metadataStores.artifacts.html b/docs/dyn/aiplatform_v1.projects.locations.metadataStores.artifacts.html index 9a3bfe837a..2feded34e5 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.metadataStores.artifacts.html +++ b/docs/dyn/aiplatform_v1.projects.locations.metadataStores.artifacts.html @@ -247,7 +247,7 @@

Method Details

parent: string, Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` (required) filter: string, Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. orderBy: string, How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. - pageSize: integer, The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. + pageSize: integer, The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. pageToken: string, A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/aiplatform_v1.projects.locations.metadataStores.contexts.html b/docs/dyn/aiplatform_v1.projects.locations.metadataStores.contexts.html index c5f0575b1f..84bc560081 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.metadataStores.contexts.html +++ b/docs/dyn/aiplatform_v1.projects.locations.metadataStores.contexts.html @@ -317,7 +317,7 @@

Method Details

parent: string, Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` (required) filter: string, Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Parent Child filtering**: To filter Contexts based on parent-child relationship use the HAS operator as follows: ``` parent_contexts: "projects//locations//metadataStores//contexts/" child_contexts: "projects//locations//metadataStores//contexts/" ``` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. orderBy: string, How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. - pageSize: integer, The maximum number of Contexts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. + pageSize: integer, The maximum number of Contexts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. pageToken: string, A page token, received from a previous MetadataService.ListContexts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/aiplatform_v1.projects.locations.metadataStores.executions.html b/docs/dyn/aiplatform_v1.projects.locations.metadataStores.executions.html index 9d10e05d65..c229a7db1d 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.metadataStores.executions.html +++ b/docs/dyn/aiplatform_v1.projects.locations.metadataStores.executions.html @@ -282,7 +282,7 @@

Method Details

parent: string, Required. The MetadataStore whose Executions should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` (required) filter: string, Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. orderBy: string, How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. - pageSize: integer, The maximum number of Executions to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. + pageSize: integer, The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. pageToken: string, A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.) x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/aiplatform_v1.projects.locations.metadataStores.html b/docs/dyn/aiplatform_v1.projects.locations.metadataStores.html index 400948e4c5..26daf29648 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.metadataStores.html +++ b/docs/dyn/aiplatform_v1.projects.locations.metadataStores.html @@ -251,7 +251,7 @@

Method Details

Args: parent: string, Required. The Location whose MetadataStores should be listed. Format: `projects/{project}/locations/{location}` (required) - pageSize: integer, The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. + pageSize: integer, The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. pageToken: string, A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/aiplatform_v1.projects.locations.metadataStores.metadataSchemas.html b/docs/dyn/aiplatform_v1.projects.locations.metadataStores.metadataSchemas.html index d13420e186..2d8d3db701 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.metadataStores.metadataSchemas.html +++ b/docs/dyn/aiplatform_v1.projects.locations.metadataStores.metadataSchemas.html @@ -163,7 +163,7 @@

Method Details

Args: parent: string, Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` (required) filter: string, A query to filter available MetadataSchemas for matching results. - pageSize: integer, The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. + pageSize: integer, The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. pageToken: string, A page token, received from a previous MetadataService.ListMetadataSchemas call. Provide this to retrieve the next page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html index 47efd6971a..ead6d15837 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html @@ -173,7 +173,7 @@

Method Details

}, ], }, - "packageSpec": { # User provided package spec like pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. + "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. @@ -315,7 +315,7 @@

Method Details

}, ], }, - "packageSpec": { # User provided package spec like pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. + "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. @@ -399,7 +399,7 @@

Method Details

}, ], }, - "packageSpec": { # User provided package spec like pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. + "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. @@ -488,7 +488,7 @@

Method Details

}, ], }, - "packageSpec": { # User provided package spec like pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. + "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. diff --git a/docs/dyn/aiplatform_v1.reasoningEngines.html b/docs/dyn/aiplatform_v1.reasoningEngines.html index 389a4ccff4..cd353c5349 100644 --- a/docs/dyn/aiplatform_v1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1.reasoningEngines.html @@ -167,7 +167,7 @@

Method Details

}, ], }, - "packageSpec": { # User provided package spec like pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. + "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. @@ -310,7 +310,7 @@

Method Details

}, ], }, - "packageSpec": { # User provided package spec like pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. + "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. @@ -394,7 +394,7 @@

Method Details

}, ], }, - "packageSpec": { # User provided package spec like pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. + "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. @@ -483,7 +483,7 @@

Method Details

}, ], }, - "packageSpec": { # User provided package spec like pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. + "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.artifacts.html b/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.artifacts.html index f9d0b46562..59ab3b359f 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.artifacts.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.artifacts.html @@ -247,7 +247,7 @@

Method Details

parent: string, Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` (required) filter: string, Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. orderBy: string, How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. - pageSize: integer, The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. + pageSize: integer, The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. pageToken: string, A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.contexts.html b/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.contexts.html index b39394c0b3..9066e83d9a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.contexts.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.contexts.html @@ -317,7 +317,7 @@

Method Details

parent: string, Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` (required) filter: string, Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Parent Child filtering**: To filter Contexts based on parent-child relationship use the HAS operator as follows: ``` parent_contexts: "projects//locations//metadataStores//contexts/" child_contexts: "projects//locations//metadataStores//contexts/" ``` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. orderBy: string, How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. - pageSize: integer, The maximum number of Contexts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. + pageSize: integer, The maximum number of Contexts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. pageToken: string, A page token, received from a previous MetadataService.ListContexts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.executions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.executions.html index a72cfceed6..4ba2477c07 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.executions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.executions.html @@ -282,7 +282,7 @@

Method Details

parent: string, Required. The MetadataStore whose Executions should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` (required) filter: string, Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. orderBy: string, How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. - pageSize: integer, The maximum number of Executions to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. + pageSize: integer, The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. pageToken: string, A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.) x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.html b/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.html index 6667a821ec..05c6a4ddb0 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.html @@ -251,7 +251,7 @@

Method Details

Args: parent: string, Required. The Location whose MetadataStores should be listed. Format: `projects/{project}/locations/{location}` (required) - pageSize: integer, The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. + pageSize: integer, The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. pageToken: string, A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.metadataSchemas.html b/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.metadataSchemas.html index 347c3b054c..9c6f4cae4f 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.metadataSchemas.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.metadataStores.metadataSchemas.html @@ -163,7 +163,7 @@

Method Details

Args: parent: string, Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` (required) filter: string, A query to filter available MetadataSchemas for matching results. - pageSize: integer, The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. + pageSize: integer, The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. pageToken: string, A page token, received from a previous MetadataService.ListMetadataSchemas call. Provide this to retrieve the next page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html index 8252487019..c8a88dad28 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html @@ -303,7 +303,7 @@

Method Details

}, ], }, - "packageSpec": { # User provided package spec like pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. + "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. @@ -550,7 +550,7 @@

Method Details

}, ], }, - "packageSpec": { # User provided package spec like pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. + "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. @@ -739,7 +739,7 @@

Method Details

}, ], }, - "packageSpec": { # User provided package spec like pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. + "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. @@ -933,7 +933,7 @@

Method Details

}, ], }, - "packageSpec": { # User provided package spec like pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. + "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html index c5a0567e62..08af9dbd6e 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html @@ -287,7 +287,7 @@

Method Details

}, ], }, - "packageSpec": { # User provided package spec like pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. + "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. @@ -535,7 +535,7 @@

Method Details

}, ], }, - "packageSpec": { # User provided package spec like pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. + "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. @@ -724,7 +724,7 @@

Method Details

}, ], }, - "packageSpec": { # User provided package spec like pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. + "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. @@ -918,7 +918,7 @@

Method Details

}, ], }, - "packageSpec": { # User provided package spec like pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. + "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. diff --git a/docs/dyn/alloydb_v1.projects.locations.clusters.html b/docs/dyn/alloydb_v1.projects.locations.clusters.html index fe05085ce8..540d05d7da 100644 --- a/docs/dyn/alloydb_v1.projects.locations.clusters.html +++ b/docs/dyn/alloydb_v1.projects.locations.clusters.html @@ -182,6 +182,35 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # Output only. Cluster created from a BackupDR backup. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrInfo": { # Information about BackupDR protection for this cluster. # Output only. Output only information about BackupDR protection for this cluster. + "currentWindow": { # Information about a single window when BackupDR was enabled for this cluster. # The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + "previousWindows": [ # Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list. + { # Information about a single window when BackupDR was enabled for this cluster. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + ], + }, "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. "backupRunId": "A String", # Required. The CloudSQL backup run ID. "instanceId": "A String", # Required. The CloudSQL instance ID. @@ -388,6 +417,35 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # Output only. Cluster created from a BackupDR backup. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrInfo": { # Information about BackupDR protection for this cluster. # Output only. Output only information about BackupDR protection for this cluster. + "currentWindow": { # Information about a single window when BackupDR was enabled for this cluster. # The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + "previousWindows": [ # Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list. + { # Information about a single window when BackupDR was enabled for this cluster. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + ], + }, "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. "backupRunId": "A String", # Required. The CloudSQL backup run ID. "instanceId": "A String", # Required. The CloudSQL instance ID. @@ -702,6 +760,35 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # Output only. Cluster created from a BackupDR backup. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrInfo": { # Information about BackupDR protection for this cluster. # Output only. Output only information about BackupDR protection for this cluster. + "currentWindow": { # Information about a single window when BackupDR was enabled for this cluster. # The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + "previousWindows": [ # Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list. + { # Information about a single window when BackupDR was enabled for this cluster. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + ], + }, "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. "backupRunId": "A String", # Required. The CloudSQL backup run ID. "instanceId": "A String", # Required. The CloudSQL instance ID. @@ -943,6 +1030,35 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # Output only. Cluster created from a BackupDR backup. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrInfo": { # Information about BackupDR protection for this cluster. # Output only. Output only information about BackupDR protection for this cluster. + "currentWindow": { # Information about a single window when BackupDR was enabled for this cluster. # The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + "previousWindows": [ # Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list. + { # Information about a single window when BackupDR was enabled for this cluster. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + ], + }, "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. "backupRunId": "A String", # Required. The CloudSQL backup run ID. "instanceId": "A String", # Required. The CloudSQL instance ID. @@ -1138,6 +1254,35 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # Output only. Cluster created from a BackupDR backup. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrInfo": { # Information about BackupDR protection for this cluster. # Output only. Output only information about BackupDR protection for this cluster. + "currentWindow": { # Information about a single window when BackupDR was enabled for this cluster. # The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + "previousWindows": [ # Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list. + { # Information about a single window when BackupDR was enabled for this cluster. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + ], + }, "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. "backupRunId": "A String", # Required. The CloudSQL backup run ID. "instanceId": "A String", # Required. The CloudSQL instance ID. @@ -1356,6 +1501,13 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # BackupDR backup source. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrPitrSource": { # Message describing a BackupDrPitrSource. # BackupDR source used for point in time recovery. + "dataSource": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id} + "pointInTime": "A String", # Required. The point in time to restore to. + }, "cluster": { # A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed. # Required. The resource being created "annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128 "a_key": "A String", @@ -1394,6 +1546,35 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # Output only. Cluster created from a BackupDR backup. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrInfo": { # Information about BackupDR protection for this cluster. # Output only. Output only information about BackupDR protection for this cluster. + "currentWindow": { # Information about a single window when BackupDR was enabled for this cluster. # The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + "previousWindows": [ # Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list. + { # Information about a single window when BackupDR was enabled for this cluster. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + ], + }, "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. "backupRunId": "A String", # Required. The CloudSQL backup run ID. "instanceId": "A String", # Required. The CloudSQL instance ID. @@ -1611,6 +1792,35 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # Output only. Cluster created from a BackupDR backup. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrInfo": { # Information about BackupDR protection for this cluster. # Output only. Output only information about BackupDR protection for this cluster. + "currentWindow": { # Information about a single window when BackupDR was enabled for this cluster. # The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + "previousWindows": [ # Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list. + { # Information about a single window when BackupDR was enabled for this cluster. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + ], + }, "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. "backupRunId": "A String", # Required. The CloudSQL backup run ID. "instanceId": "A String", # Required. The CloudSQL instance ID. diff --git a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html index cd358dc7ff..999bf3cf3a 100644 --- a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html @@ -224,6 +224,27 @@

Method Details

"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. + "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. + "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. + "coolDownPeriodSec": "A String", # The period of time in seconds after a new node is created before the autoscaler will incorporate its resource usage (e.g. CPU utilization) into the autoscaling recommendation algorithm. + "cpuUtilization": { # CPU utilization policy for the autoscaler. # CPU utilization policy for the autoscaler. + "utilizationTarget": 3.14, # Target CPU utilization as a float between 0 and 1. + }, + "enabled": True or False, # If true, autoscaling is enabled for the instance. If not set, the default value is false. + "maxNodeCount": "A String", # Maximum number of nodes for the autoscaler. + }, + "schedules": [ # Optional list of schedules for the MIG autoscaler. If not set, no schedules are created. + { # A schedule for the autoscaler. + "cronExpression": "A String", # Cron expression for the triggering the schedule. See https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions for the syntax. + "description": "A String", # Description of the schedule. + "disabled": True or False, # If true, the schedule is disabled. + "durationSec": "A String", # Duration of the schedule. + "minNodeCount": "A String", # Minimum number of nodes in while the schedule is active. + "name": "A String", # Name of the schedule. + "timeZone": "A String", # The location-based IANA time zone for interpreting the schedule's start time. If no time zone is provided, UTC is used by default. + }, + ], + }, "nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance. }, "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. @@ -379,6 +400,27 @@

Method Details

"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. + "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. + "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. + "coolDownPeriodSec": "A String", # The period of time in seconds after a new node is created before the autoscaler will incorporate its resource usage (e.g. CPU utilization) into the autoscaling recommendation algorithm. + "cpuUtilization": { # CPU utilization policy for the autoscaler. # CPU utilization policy for the autoscaler. + "utilizationTarget": 3.14, # Target CPU utilization as a float between 0 and 1. + }, + "enabled": True or False, # If true, autoscaling is enabled for the instance. If not set, the default value is false. + "maxNodeCount": "A String", # Maximum number of nodes for the autoscaler. + }, + "schedules": [ # Optional list of schedules for the MIG autoscaler. If not set, no schedules are created. + { # A schedule for the autoscaler. + "cronExpression": "A String", # Cron expression for the triggering the schedule. See https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions for the syntax. + "description": "A String", # Description of the schedule. + "disabled": True or False, # If true, the schedule is disabled. + "durationSec": "A String", # Duration of the schedule. + "minNodeCount": "A String", # Minimum number of nodes in while the schedule is active. + "name": "A String", # Name of the schedule. + "timeZone": "A String", # The location-based IANA time zone for interpreting the schedule's start time. If no time zone is provided, UTC is used by default. + }, + ], + }, "nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance. }, "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. @@ -625,6 +667,27 @@

Method Details

"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. + "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. + "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. + "coolDownPeriodSec": "A String", # The period of time in seconds after a new node is created before the autoscaler will incorporate its resource usage (e.g. CPU utilization) into the autoscaling recommendation algorithm. + "cpuUtilization": { # CPU utilization policy for the autoscaler. # CPU utilization policy for the autoscaler. + "utilizationTarget": 3.14, # Target CPU utilization as a float between 0 and 1. + }, + "enabled": True or False, # If true, autoscaling is enabled for the instance. If not set, the default value is false. + "maxNodeCount": "A String", # Maximum number of nodes for the autoscaler. + }, + "schedules": [ # Optional list of schedules for the MIG autoscaler. If not set, no schedules are created. + { # A schedule for the autoscaler. + "cronExpression": "A String", # Cron expression for the triggering the schedule. See https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions for the syntax. + "description": "A String", # Description of the schedule. + "disabled": True or False, # If true, the schedule is disabled. + "durationSec": "A String", # Duration of the schedule. + "minNodeCount": "A String", # Minimum number of nodes in while the schedule is active. + "name": "A String", # Name of the schedule. + "timeZone": "A String", # The location-based IANA time zone for interpreting the schedule's start time. If no time zone is provided, UTC is used by default. + }, + ], + }, "nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance. }, "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. @@ -827,6 +890,27 @@

Method Details

"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. + "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. + "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. + "coolDownPeriodSec": "A String", # The period of time in seconds after a new node is created before the autoscaler will incorporate its resource usage (e.g. CPU utilization) into the autoscaling recommendation algorithm. + "cpuUtilization": { # CPU utilization policy for the autoscaler. # CPU utilization policy for the autoscaler. + "utilizationTarget": 3.14, # Target CPU utilization as a float between 0 and 1. + }, + "enabled": True or False, # If true, autoscaling is enabled for the instance. If not set, the default value is false. + "maxNodeCount": "A String", # Maximum number of nodes for the autoscaler. + }, + "schedules": [ # Optional list of schedules for the MIG autoscaler. If not set, no schedules are created. + { # A schedule for the autoscaler. + "cronExpression": "A String", # Cron expression for the triggering the schedule. See https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions for the syntax. + "description": "A String", # Description of the schedule. + "disabled": True or False, # If true, the schedule is disabled. + "durationSec": "A String", # Duration of the schedule. + "minNodeCount": "A String", # Minimum number of nodes in while the schedule is active. + "name": "A String", # Name of the schedule. + "timeZone": "A String", # The location-based IANA time zone for interpreting the schedule's start time. If no time zone is provided, UTC is used by default. + }, + ], + }, "nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance. }, "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. @@ -971,6 +1055,27 @@

Method Details

"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. + "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. + "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. + "coolDownPeriodSec": "A String", # The period of time in seconds after a new node is created before the autoscaler will incorporate its resource usage (e.g. CPU utilization) into the autoscaling recommendation algorithm. + "cpuUtilization": { # CPU utilization policy for the autoscaler. # CPU utilization policy for the autoscaler. + "utilizationTarget": 3.14, # Target CPU utilization as a float between 0 and 1. + }, + "enabled": True or False, # If true, autoscaling is enabled for the instance. If not set, the default value is false. + "maxNodeCount": "A String", # Maximum number of nodes for the autoscaler. + }, + "schedules": [ # Optional list of schedules for the MIG autoscaler. If not set, no schedules are created. + { # A schedule for the autoscaler. + "cronExpression": "A String", # Cron expression for the triggering the schedule. See https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions for the syntax. + "description": "A String", # Description of the schedule. + "disabled": True or False, # If true, the schedule is disabled. + "durationSec": "A String", # Duration of the schedule. + "minNodeCount": "A String", # Minimum number of nodes in while the schedule is active. + "name": "A String", # Name of the schedule. + "timeZone": "A String", # The location-based IANA time zone for interpreting the schedule's start time. If no time zone is provided, UTC is used by default. + }, + ], + }, "nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance. }, "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. diff --git a/docs/dyn/alloydb_v1.projects.locations.operations.html b/docs/dyn/alloydb_v1.projects.locations.operations.html index 7e106f7c2a..b54e8278d7 100644 --- a/docs/dyn/alloydb_v1.projects.locations.operations.html +++ b/docs/dyn/alloydb_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html index d953c3c8c8..6f7bc5dc4d 100644 --- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html +++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html @@ -182,6 +182,35 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # Output only. Cluster created from a BackupDR backup. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrInfo": { # Information about BackupDR protection for this cluster. # Output only. Output only information about BackupDR protection for this cluster. + "currentWindow": { # Information about a single window when BackupDR was enabled for this cluster. # The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + "previousWindows": [ # Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list. + { # Information about a single window when BackupDR was enabled for this cluster. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + ], + }, "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. "backupRunId": "A String", # Required. The CloudSQL backup run ID. "instanceId": "A String", # Required. The CloudSQL instance ID. @@ -393,6 +422,35 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # Output only. Cluster created from a BackupDR backup. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrInfo": { # Information about BackupDR protection for this cluster. # Output only. Output only information about BackupDR protection for this cluster. + "currentWindow": { # Information about a single window when BackupDR was enabled for this cluster. # The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + "previousWindows": [ # Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list. + { # Information about a single window when BackupDR was enabled for this cluster. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + ], + }, "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. "backupRunId": "A String", # Required. The CloudSQL backup run ID. "instanceId": "A String", # Required. The CloudSQL instance ID. @@ -712,6 +770,35 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # Output only. Cluster created from a BackupDR backup. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrInfo": { # Information about BackupDR protection for this cluster. # Output only. Output only information about BackupDR protection for this cluster. + "currentWindow": { # Information about a single window when BackupDR was enabled for this cluster. # The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + "previousWindows": [ # Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list. + { # Information about a single window when BackupDR was enabled for this cluster. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + ], + }, "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. "backupRunId": "A String", # Required. The CloudSQL backup run ID. "instanceId": "A String", # Required. The CloudSQL instance ID. @@ -958,6 +1045,35 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # Output only. Cluster created from a BackupDR backup. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrInfo": { # Information about BackupDR protection for this cluster. # Output only. Output only information about BackupDR protection for this cluster. + "currentWindow": { # Information about a single window when BackupDR was enabled for this cluster. # The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + "previousWindows": [ # Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list. + { # Information about a single window when BackupDR was enabled for this cluster. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + ], + }, "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. "backupRunId": "A String", # Required. The CloudSQL backup run ID. "instanceId": "A String", # Required. The CloudSQL instance ID. @@ -1158,6 +1274,35 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # Output only. Cluster created from a BackupDR backup. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrInfo": { # Information about BackupDR protection for this cluster. # Output only. Output only information about BackupDR protection for this cluster. + "currentWindow": { # Information about a single window when BackupDR was enabled for this cluster. # The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + "previousWindows": [ # Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list. + { # Information about a single window when BackupDR was enabled for this cluster. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + ], + }, "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. "backupRunId": "A String", # Required. The CloudSQL backup run ID. "instanceId": "A String", # Required. The CloudSQL instance ID. @@ -1381,6 +1526,13 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # BackupDR backup source. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrPitrSource": { # Message describing a BackupDrPitrSource. # BackupDR source used for point in time recovery. + "dataSource": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id} + "pointInTime": "A String", # Required. The point in time to restore to. + }, "cluster": { # A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed. # Required. The resource being created "annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128 "a_key": "A String", @@ -1419,6 +1571,35 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # Output only. Cluster created from a BackupDR backup. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrInfo": { # Information about BackupDR protection for this cluster. # Output only. Output only information about BackupDR protection for this cluster. + "currentWindow": { # Information about a single window when BackupDR was enabled for this cluster. # The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + "previousWindows": [ # Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list. + { # Information about a single window when BackupDR was enabled for this cluster. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + ], + }, "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. "backupRunId": "A String", # Required. The CloudSQL backup run ID. "instanceId": "A String", # Required. The CloudSQL instance ID. @@ -1641,6 +1822,35 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # Output only. Cluster created from a BackupDR backup. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrInfo": { # Information about BackupDR protection for this cluster. # Output only. Output only information about BackupDR protection for this cluster. + "currentWindow": { # Information about a single window when BackupDR was enabled for this cluster. # The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + "previousWindows": [ # Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list. + { # Information about a single window when BackupDR was enabled for this cluster. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + ], + }, "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. "backupRunId": "A String", # Required. The CloudSQL backup run ID. "instanceId": "A String", # Required. The CloudSQL instance ID. diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html index 85a3511f6f..51247ac8dc 100644 --- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html @@ -246,6 +246,27 @@

Method Details

"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. + "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. + "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. + "coolDownPeriodSec": "A String", # The period of time in seconds after a new node is created before the autoscaler will incorporate its resource usage (e.g. CPU utilization) into the autoscaling recommendation algorithm. + "cpuUtilization": { # CPU utilization policy for the autoscaler. # CPU utilization policy for the autoscaler. + "utilizationTarget": 3.14, # Target CPU utilization as a float between 0 and 1. + }, + "enabled": True or False, # If true, autoscaling is enabled for the instance. If not set, the default value is false. + "maxNodeCount": "A String", # Maximum number of nodes for the autoscaler. + }, + "schedules": [ # Optional list of schedules for the MIG autoscaler. If not set, no schedules are created. + { # A schedule for the autoscaler. + "cronExpression": "A String", # Cron expression for the triggering the schedule. See https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions for the syntax. + "description": "A String", # Description of the schedule. + "disabled": True or False, # If true, the schedule is disabled. + "durationSec": "A String", # Duration of the schedule. + "minNodeCount": "A String", # Minimum number of nodes in while the schedule is active. + "name": "A String", # Name of the schedule. + "timeZone": "A String", # The location-based IANA time zone for interpreting the schedule's start time. If no time zone is provided, UTC is used by default. + }, + ], + }, "nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance. }, "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. @@ -427,6 +448,27 @@

Method Details

"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. + "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. + "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. + "coolDownPeriodSec": "A String", # The period of time in seconds after a new node is created before the autoscaler will incorporate its resource usage (e.g. CPU utilization) into the autoscaling recommendation algorithm. + "cpuUtilization": { # CPU utilization policy for the autoscaler. # CPU utilization policy for the autoscaler. + "utilizationTarget": 3.14, # Target CPU utilization as a float between 0 and 1. + }, + "enabled": True or False, # If true, autoscaling is enabled for the instance. If not set, the default value is false. + "maxNodeCount": "A String", # Maximum number of nodes for the autoscaler. + }, + "schedules": [ # Optional list of schedules for the MIG autoscaler. If not set, no schedules are created. + { # A schedule for the autoscaler. + "cronExpression": "A String", # Cron expression for the triggering the schedule. See https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions for the syntax. + "description": "A String", # Description of the schedule. + "disabled": True or False, # If true, the schedule is disabled. + "durationSec": "A String", # Duration of the schedule. + "minNodeCount": "A String", # Minimum number of nodes in while the schedule is active. + "name": "A String", # Name of the schedule. + "timeZone": "A String", # The location-based IANA time zone for interpreting the schedule's start time. If no time zone is provided, UTC is used by default. + }, + ], + }, "nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance. }, "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. @@ -699,6 +741,27 @@

Method Details

"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. + "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. + "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. + "coolDownPeriodSec": "A String", # The period of time in seconds after a new node is created before the autoscaler will incorporate its resource usage (e.g. CPU utilization) into the autoscaling recommendation algorithm. + "cpuUtilization": { # CPU utilization policy for the autoscaler. # CPU utilization policy for the autoscaler. + "utilizationTarget": 3.14, # Target CPU utilization as a float between 0 and 1. + }, + "enabled": True or False, # If true, autoscaling is enabled for the instance. If not set, the default value is false. + "maxNodeCount": "A String", # Maximum number of nodes for the autoscaler. + }, + "schedules": [ # Optional list of schedules for the MIG autoscaler. If not set, no schedules are created. + { # A schedule for the autoscaler. + "cronExpression": "A String", # Cron expression for the triggering the schedule. See https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions for the syntax. + "description": "A String", # Description of the schedule. + "disabled": True or False, # If true, the schedule is disabled. + "durationSec": "A String", # Duration of the schedule. + "minNodeCount": "A String", # Minimum number of nodes in while the schedule is active. + "name": "A String", # Name of the schedule. + "timeZone": "A String", # The location-based IANA time zone for interpreting the schedule's start time. If no time zone is provided, UTC is used by default. + }, + ], + }, "nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance. }, "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. @@ -931,6 +994,27 @@

Method Details

"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. + "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. + "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. + "coolDownPeriodSec": "A String", # The period of time in seconds after a new node is created before the autoscaler will incorporate its resource usage (e.g. CPU utilization) into the autoscaling recommendation algorithm. + "cpuUtilization": { # CPU utilization policy for the autoscaler. # CPU utilization policy for the autoscaler. + "utilizationTarget": 3.14, # Target CPU utilization as a float between 0 and 1. + }, + "enabled": True or False, # If true, autoscaling is enabled for the instance. If not set, the default value is false. + "maxNodeCount": "A String", # Maximum number of nodes for the autoscaler. + }, + "schedules": [ # Optional list of schedules for the MIG autoscaler. If not set, no schedules are created. + { # A schedule for the autoscaler. + "cronExpression": "A String", # Cron expression for the triggering the schedule. See https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions for the syntax. + "description": "A String", # Description of the schedule. + "disabled": True or False, # If true, the schedule is disabled. + "durationSec": "A String", # Duration of the schedule. + "minNodeCount": "A String", # Minimum number of nodes in while the schedule is active. + "name": "A String", # Name of the schedule. + "timeZone": "A String", # The location-based IANA time zone for interpreting the schedule's start time. If no time zone is provided, UTC is used by default. + }, + ], + }, "nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance. }, "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. @@ -1101,6 +1185,27 @@

Method Details

"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. + "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. + "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. + "coolDownPeriodSec": "A String", # The period of time in seconds after a new node is created before the autoscaler will incorporate its resource usage (e.g. CPU utilization) into the autoscaling recommendation algorithm. + "cpuUtilization": { # CPU utilization policy for the autoscaler. # CPU utilization policy for the autoscaler. + "utilizationTarget": 3.14, # Target CPU utilization as a float between 0 and 1. + }, + "enabled": True or False, # If true, autoscaling is enabled for the instance. If not set, the default value is false. + "maxNodeCount": "A String", # Maximum number of nodes for the autoscaler. + }, + "schedules": [ # Optional list of schedules for the MIG autoscaler. If not set, no schedules are created. + { # A schedule for the autoscaler. + "cronExpression": "A String", # Cron expression for the triggering the schedule. See https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions for the syntax. + "description": "A String", # Description of the schedule. + "disabled": True or False, # If true, the schedule is disabled. + "durationSec": "A String", # Duration of the schedule. + "minNodeCount": "A String", # Minimum number of nodes in while the schedule is active. + "name": "A String", # Name of the schedule. + "timeZone": "A String", # The location-based IANA time zone for interpreting the schedule's start time. If no time zone is provided, UTC is used by default. + }, + ], + }, "nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance. }, "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.operations.html b/docs/dyn/alloydb_v1alpha.projects.locations.operations.html index 7d39b2bd20..acebe7f42a 100644 --- a/docs/dyn/alloydb_v1alpha.projects.locations.operations.html +++ b/docs/dyn/alloydb_v1alpha.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html index fbda430c38..c4d9813ddf 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html @@ -182,6 +182,35 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # Output only. Cluster created from a BackupDR backup. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrInfo": { # Information about BackupDR protection for this cluster. # Output only. Output only information about BackupDR protection for this cluster. + "currentWindow": { # Information about a single window when BackupDR was enabled for this cluster. # The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + "previousWindows": [ # Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list. + { # Information about a single window when BackupDR was enabled for this cluster. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + ], + }, "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. "backupRunId": "A String", # Required. The CloudSQL backup run ID. "instanceId": "A String", # Required. The CloudSQL instance ID. @@ -392,6 +421,35 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # Output only. Cluster created from a BackupDR backup. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrInfo": { # Information about BackupDR protection for this cluster. # Output only. Output only information about BackupDR protection for this cluster. + "currentWindow": { # Information about a single window when BackupDR was enabled for this cluster. # The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + "previousWindows": [ # Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list. + { # Information about a single window when BackupDR was enabled for this cluster. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + ], + }, "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. "backupRunId": "A String", # Required. The CloudSQL backup run ID. "instanceId": "A String", # Required. The CloudSQL instance ID. @@ -710,6 +768,35 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # Output only. Cluster created from a BackupDR backup. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrInfo": { # Information about BackupDR protection for this cluster. # Output only. Output only information about BackupDR protection for this cluster. + "currentWindow": { # Information about a single window when BackupDR was enabled for this cluster. # The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + "previousWindows": [ # Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list. + { # Information about a single window when BackupDR was enabled for this cluster. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + ], + }, "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. "backupRunId": "A String", # Required. The CloudSQL backup run ID. "instanceId": "A String", # Required. The CloudSQL instance ID. @@ -955,6 +1042,35 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # Output only. Cluster created from a BackupDR backup. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrInfo": { # Information about BackupDR protection for this cluster. # Output only. Output only information about BackupDR protection for this cluster. + "currentWindow": { # Information about a single window when BackupDR was enabled for this cluster. # The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + "previousWindows": [ # Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list. + { # Information about a single window when BackupDR was enabled for this cluster. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + ], + }, "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. "backupRunId": "A String", # Required. The CloudSQL backup run ID. "instanceId": "A String", # Required. The CloudSQL instance ID. @@ -1154,6 +1270,35 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # Output only. Cluster created from a BackupDR backup. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrInfo": { # Information about BackupDR protection for this cluster. # Output only. Output only information about BackupDR protection for this cluster. + "currentWindow": { # Information about a single window when BackupDR was enabled for this cluster. # The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + "previousWindows": [ # Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list. + { # Information about a single window when BackupDR was enabled for this cluster. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + ], + }, "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. "backupRunId": "A String", # Required. The CloudSQL backup run ID. "instanceId": "A String", # Required. The CloudSQL instance ID. @@ -1376,6 +1521,13 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # BackupDR backup source. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrPitrSource": { # Message describing a BackupDrPitrSource. # BackupDR source used for point in time recovery. + "dataSource": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id} + "pointInTime": "A String", # Required. The point in time to restore to. + }, "cluster": { # A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed. # Required. The resource being created "annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128 "a_key": "A String", @@ -1414,6 +1566,35 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # Output only. Cluster created from a BackupDR backup. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrInfo": { # Information about BackupDR protection for this cluster. # Output only. Output only information about BackupDR protection for this cluster. + "currentWindow": { # Information about a single window when BackupDR was enabled for this cluster. # The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + "previousWindows": [ # Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list. + { # Information about a single window when BackupDR was enabled for this cluster. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + ], + }, "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. "backupRunId": "A String", # Required. The CloudSQL backup run ID. "instanceId": "A String", # Required. The CloudSQL instance ID. @@ -1635,6 +1816,35 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "backupdrBackupSource": { # Message describing a BackupDrBackupSource. # Output only. Cluster created from a BackupDR backup. + "backup": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + }, + "backupdrInfo": { # Information about BackupDR protection for this cluster. # Output only. Output only information about BackupDR protection for this cluster. + "currentWindow": { # Information about a single window when BackupDR was enabled for this cluster. # The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + "previousWindows": [ # Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list. + { # Information about a single window when BackupDR was enabled for this cluster. + "automatedBackupPreviouslyEnabled": True or False, # Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster. + "backupPlanAssociation": "A String", # The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster. + "continuousBackupPreviousRecoveryWindowDays": 42, # The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabled": True or False, # Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "continuousBackupPreviouslyEnabledTime": "A String", # The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster. + "dataSource": "A String", # The DataSource resource that represents the cluster in BackupDR. + "disabledTime": "A String", # Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`. + "enabledTime": "A String", # Time when the BackupDR protection for this cluster was enabled. + "logRetentionPeriod": "A String", # The retention period for logs generated by BackupDR for this cluster. + }, + ], + }, "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. "backupRunId": "A String", # Required. The CloudSQL backup run ID. "instanceId": "A String", # Required. The CloudSQL instance ID. diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html index b6600bebd9..649e6dd718 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html @@ -246,6 +246,27 @@

Method Details

"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. + "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. + "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. + "coolDownPeriodSec": "A String", # The period of time in seconds after a new node is created before the autoscaler will incorporate its resource usage (e.g. CPU utilization) into the autoscaling recommendation algorithm. + "cpuUtilization": { # CPU utilization policy for the autoscaler. # CPU utilization policy for the autoscaler. + "utilizationTarget": 3.14, # Target CPU utilization as a float between 0 and 1. + }, + "enabled": True or False, # If true, autoscaling is enabled for the instance. If not set, the default value is false. + "maxNodeCount": "A String", # Maximum number of nodes for the autoscaler. + }, + "schedules": [ # Optional list of schedules for the MIG autoscaler. If not set, no schedules are created. + { # A schedule for the autoscaler. + "cronExpression": "A String", # Cron expression for the triggering the schedule. See https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions for the syntax. + "description": "A String", # Description of the schedule. + "disabled": True or False, # If true, the schedule is disabled. + "durationSec": "A String", # Duration of the schedule. + "minNodeCount": "A String", # Minimum number of nodes in while the schedule is active. + "name": "A String", # Name of the schedule. + "timeZone": "A String", # The location-based IANA time zone for interpreting the schedule's start time. If no time zone is provided, UTC is used by default. + }, + ], + }, "nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance. }, "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. @@ -426,6 +447,27 @@

Method Details

"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. + "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. + "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. + "coolDownPeriodSec": "A String", # The period of time in seconds after a new node is created before the autoscaler will incorporate its resource usage (e.g. CPU utilization) into the autoscaling recommendation algorithm. + "cpuUtilization": { # CPU utilization policy for the autoscaler. # CPU utilization policy for the autoscaler. + "utilizationTarget": 3.14, # Target CPU utilization as a float between 0 and 1. + }, + "enabled": True or False, # If true, autoscaling is enabled for the instance. If not set, the default value is false. + "maxNodeCount": "A String", # Maximum number of nodes for the autoscaler. + }, + "schedules": [ # Optional list of schedules for the MIG autoscaler. If not set, no schedules are created. + { # A schedule for the autoscaler. + "cronExpression": "A String", # Cron expression for the triggering the schedule. See https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions for the syntax. + "description": "A String", # Description of the schedule. + "disabled": True or False, # If true, the schedule is disabled. + "durationSec": "A String", # Duration of the schedule. + "minNodeCount": "A String", # Minimum number of nodes in while the schedule is active. + "name": "A String", # Name of the schedule. + "timeZone": "A String", # The location-based IANA time zone for interpreting the schedule's start time. If no time zone is provided, UTC is used by default. + }, + ], + }, "nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance. }, "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. @@ -697,6 +739,27 @@

Method Details

"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. + "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. + "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. + "coolDownPeriodSec": "A String", # The period of time in seconds after a new node is created before the autoscaler will incorporate its resource usage (e.g. CPU utilization) into the autoscaling recommendation algorithm. + "cpuUtilization": { # CPU utilization policy for the autoscaler. # CPU utilization policy for the autoscaler. + "utilizationTarget": 3.14, # Target CPU utilization as a float between 0 and 1. + }, + "enabled": True or False, # If true, autoscaling is enabled for the instance. If not set, the default value is false. + "maxNodeCount": "A String", # Maximum number of nodes for the autoscaler. + }, + "schedules": [ # Optional list of schedules for the MIG autoscaler. If not set, no schedules are created. + { # A schedule for the autoscaler. + "cronExpression": "A String", # Cron expression for the triggering the schedule. See https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions for the syntax. + "description": "A String", # Description of the schedule. + "disabled": True or False, # If true, the schedule is disabled. + "durationSec": "A String", # Duration of the schedule. + "minNodeCount": "A String", # Minimum number of nodes in while the schedule is active. + "name": "A String", # Name of the schedule. + "timeZone": "A String", # The location-based IANA time zone for interpreting the schedule's start time. If no time zone is provided, UTC is used by default. + }, + ], + }, "nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance. }, "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. @@ -928,6 +991,27 @@

Method Details

"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. + "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. + "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. + "coolDownPeriodSec": "A String", # The period of time in seconds after a new node is created before the autoscaler will incorporate its resource usage (e.g. CPU utilization) into the autoscaling recommendation algorithm. + "cpuUtilization": { # CPU utilization policy for the autoscaler. # CPU utilization policy for the autoscaler. + "utilizationTarget": 3.14, # Target CPU utilization as a float between 0 and 1. + }, + "enabled": True or False, # If true, autoscaling is enabled for the instance. If not set, the default value is false. + "maxNodeCount": "A String", # Maximum number of nodes for the autoscaler. + }, + "schedules": [ # Optional list of schedules for the MIG autoscaler. If not set, no schedules are created. + { # A schedule for the autoscaler. + "cronExpression": "A String", # Cron expression for the triggering the schedule. See https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions for the syntax. + "description": "A String", # Description of the schedule. + "disabled": True or False, # If true, the schedule is disabled. + "durationSec": "A String", # Duration of the schedule. + "minNodeCount": "A String", # Minimum number of nodes in while the schedule is active. + "name": "A String", # Name of the schedule. + "timeZone": "A String", # The location-based IANA time zone for interpreting the schedule's start time. If no time zone is provided, UTC is used by default. + }, + ], + }, "nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance. }, "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. @@ -1097,6 +1181,27 @@

Method Details

"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. + "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. + "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. + "coolDownPeriodSec": "A String", # The period of time in seconds after a new node is created before the autoscaler will incorporate its resource usage (e.g. CPU utilization) into the autoscaling recommendation algorithm. + "cpuUtilization": { # CPU utilization policy for the autoscaler. # CPU utilization policy for the autoscaler. + "utilizationTarget": 3.14, # Target CPU utilization as a float between 0 and 1. + }, + "enabled": True or False, # If true, autoscaling is enabled for the instance. If not set, the default value is false. + "maxNodeCount": "A String", # Maximum number of nodes for the autoscaler. + }, + "schedules": [ # Optional list of schedules for the MIG autoscaler. If not set, no schedules are created. + { # A schedule for the autoscaler. + "cronExpression": "A String", # Cron expression for the triggering the schedule. See https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions for the syntax. + "description": "A String", # Description of the schedule. + "disabled": True or False, # If true, the schedule is disabled. + "durationSec": "A String", # Duration of the schedule. + "minNodeCount": "A String", # Minimum number of nodes in while the schedule is active. + "name": "A String", # Name of the schedule. + "timeZone": "A String", # The location-based IANA time zone for interpreting the schedule's start time. If no time zone is provided, UTC is used by default. + }, + ], + }, "nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance. }, "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. diff --git a/docs/dyn/alloydb_v1beta.projects.locations.operations.html b/docs/dyn/alloydb_v1beta.projects.locations.operations.html index d87318231a..cbb221e9f9 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.operations.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -170,7 +170,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -178,6 +178,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -209,6 +210,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/apigee_v1.organizations.instances.html b/docs/dyn/apigee_v1.organizations.instances.html index 9c28e0f0c0..7409e8013d 100644 --- a/docs/dyn/apigee_v1.organizations.instances.html +++ b/docs/dyn/apigee_v1.organizations.instances.html @@ -142,12 +142,30 @@

Method Details

"displayName": "A String", # Optional. Display name for the instance. "host": "A String", # Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service. "ipRange": "A String", # Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or `a.b.c.d/22,e.f.g.h/28` + "isVersionLocked": True or False, # Output only. Indicates whether the instance is version locked. If true, the instance will not be updated by automated runtime rollouts. This is only supported for Apigee X instances. "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch. "location": "A String", # Required. Compute Engine location where the instance resides. + "maintenanceUpdatePolicy": { # MaintenanceUpdatePolicy specifies the preferred window to perform maintenance on the instance (day of the week and time of day). # Optional. Apigee customers can set the preferred window to perform maintenance on the instance (day of the week and time of day). + "maintenanceChannel": "A String", # Optional. Maintenance channel to specify relative scheduling for maintenance. + "maintenanceWindows": [ # Optional. Preferred windows to perform maintenance. Currently limited to 1. + { # MaintenanceWindow specifies the preferred day of the week and time of day to perform maintenance. + "day": "A String", # Required. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc. + "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`. # Required. The start time (UTC) of the maintenance window. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + ], + }, "name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`. "peeringCidrRange": "A String", # Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support `SLASH_16` to `SLASH_20` and defaults to `SLASH_16`. Evaluation organizations support only `SLASH_23`. "port": "A String", # Output only. Port number of the exposed Apigee endpoint. "runtimeVersion": "A String", # Output only. Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments. + "scheduledMaintenance": { # Scheduled maintenance information for an instance. # Output only. Time and date of the scheduled maintenance for this instance. This field is only populated for instances that have opted into Maintenance Window and if there is an upcoming maintenance. Cleared once the maintenance is complete. + "startTime": "A String", # Output only. The start time (UTC) of the scheduled maintenance. + }, "serviceAttachment": "A String", # Output only. Resource name of the service attachment created for the instance in the format: `projects/*/regions/*/serviceAttachments/*` Apigee customers can privately forward traffic to this service attachment using the PSC endpoints. "state": "A String", # Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use. } @@ -244,12 +262,30 @@

Method Details

"displayName": "A String", # Optional. Display name for the instance. "host": "A String", # Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service. "ipRange": "A String", # Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or `a.b.c.d/22,e.f.g.h/28` + "isVersionLocked": True or False, # Output only. Indicates whether the instance is version locked. If true, the instance will not be updated by automated runtime rollouts. This is only supported for Apigee X instances. "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch. "location": "A String", # Required. Compute Engine location where the instance resides. + "maintenanceUpdatePolicy": { # MaintenanceUpdatePolicy specifies the preferred window to perform maintenance on the instance (day of the week and time of day). # Optional. Apigee customers can set the preferred window to perform maintenance on the instance (day of the week and time of day). + "maintenanceChannel": "A String", # Optional. Maintenance channel to specify relative scheduling for maintenance. + "maintenanceWindows": [ # Optional. Preferred windows to perform maintenance. Currently limited to 1. + { # MaintenanceWindow specifies the preferred day of the week and time of day to perform maintenance. + "day": "A String", # Required. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc. + "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`. # Required. The start time (UTC) of the maintenance window. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + ], + }, "name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`. "peeringCidrRange": "A String", # Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support `SLASH_16` to `SLASH_20` and defaults to `SLASH_16`. Evaluation organizations support only `SLASH_23`. "port": "A String", # Output only. Port number of the exposed Apigee endpoint. "runtimeVersion": "A String", # Output only. Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments. + "scheduledMaintenance": { # Scheduled maintenance information for an instance. # Output only. Time and date of the scheduled maintenance for this instance. This field is only populated for instances that have opted into Maintenance Window and if there is an upcoming maintenance. Cleared once the maintenance is complete. + "startTime": "A String", # Output only. The start time (UTC) of the scheduled maintenance. + }, "serviceAttachment": "A String", # Output only. Resource name of the service attachment created for the instance in the format: `projects/*/regions/*/serviceAttachments/*` Apigee customers can privately forward traffic to this service attachment using the PSC endpoints. "state": "A String", # Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use. } @@ -287,12 +323,30 @@

Method Details

"displayName": "A String", # Optional. Display name for the instance. "host": "A String", # Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service. "ipRange": "A String", # Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or `a.b.c.d/22,e.f.g.h/28` + "isVersionLocked": True or False, # Output only. Indicates whether the instance is version locked. If true, the instance will not be updated by automated runtime rollouts. This is only supported for Apigee X instances. "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch. "location": "A String", # Required. Compute Engine location where the instance resides. + "maintenanceUpdatePolicy": { # MaintenanceUpdatePolicy specifies the preferred window to perform maintenance on the instance (day of the week and time of day). # Optional. Apigee customers can set the preferred window to perform maintenance on the instance (day of the week and time of day). + "maintenanceChannel": "A String", # Optional. Maintenance channel to specify relative scheduling for maintenance. + "maintenanceWindows": [ # Optional. Preferred windows to perform maintenance. Currently limited to 1. + { # MaintenanceWindow specifies the preferred day of the week and time of day to perform maintenance. + "day": "A String", # Required. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc. + "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`. # Required. The start time (UTC) of the maintenance window. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + ], + }, "name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`. "peeringCidrRange": "A String", # Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support `SLASH_16` to `SLASH_20` and defaults to `SLASH_16`. Evaluation organizations support only `SLASH_23`. "port": "A String", # Output only. Port number of the exposed Apigee endpoint. "runtimeVersion": "A String", # Output only. Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments. + "scheduledMaintenance": { # Scheduled maintenance information for an instance. # Output only. Time and date of the scheduled maintenance for this instance. This field is only populated for instances that have opted into Maintenance Window and if there is an upcoming maintenance. Cleared once the maintenance is complete. + "startTime": "A String", # Output only. The start time (UTC) of the scheduled maintenance. + }, "serviceAttachment": "A String", # Output only. Resource name of the service attachment created for the instance in the format: `projects/*/regions/*/serviceAttachments/*` Apigee customers can privately forward traffic to this service attachment using the PSC endpoints. "state": "A String", # Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use. }, @@ -338,12 +392,30 @@

Method Details

"displayName": "A String", # Optional. Display name for the instance. "host": "A String", # Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service. "ipRange": "A String", # Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or `a.b.c.d/22,e.f.g.h/28` + "isVersionLocked": True or False, # Output only. Indicates whether the instance is version locked. If true, the instance will not be updated by automated runtime rollouts. This is only supported for Apigee X instances. "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch. "location": "A String", # Required. Compute Engine location where the instance resides. + "maintenanceUpdatePolicy": { # MaintenanceUpdatePolicy specifies the preferred window to perform maintenance on the instance (day of the week and time of day). # Optional. Apigee customers can set the preferred window to perform maintenance on the instance (day of the week and time of day). + "maintenanceChannel": "A String", # Optional. Maintenance channel to specify relative scheduling for maintenance. + "maintenanceWindows": [ # Optional. Preferred windows to perform maintenance. Currently limited to 1. + { # MaintenanceWindow specifies the preferred day of the week and time of day to perform maintenance. + "day": "A String", # Required. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc. + "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`. # Required. The start time (UTC) of the maintenance window. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + ], + }, "name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`. "peeringCidrRange": "A String", # Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support `SLASH_16` to `SLASH_20` and defaults to `SLASH_16`. Evaluation organizations support only `SLASH_23`. "port": "A String", # Output only. Port number of the exposed Apigee endpoint. "runtimeVersion": "A String", # Output only. Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments. + "scheduledMaintenance": { # Scheduled maintenance information for an instance. # Output only. Time and date of the scheduled maintenance for this instance. This field is only populated for instances that have opted into Maintenance Window and if there is an upcoming maintenance. Cleared once the maintenance is complete. + "startTime": "A String", # Output only. The start time (UTC) of the scheduled maintenance. + }, "serviceAttachment": "A String", # Output only. Resource name of the service attachment created for the instance in the format: `projects/*/regions/*/serviceAttachments/*` Apigee customers can privately forward traffic to this service attachment using the PSC endpoints. "state": "A String", # Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use. } diff --git a/docs/dyn/apigee_v1.organizations.operations.html b/docs/dyn/apigee_v1.organizations.operations.html index 0da4640f1b..2dd35dcb80 100644 --- a/docs/dyn/apigee_v1.organizations.operations.html +++ b/docs/dyn/apigee_v1.organizations.operations.html @@ -81,7 +81,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -128,7 +128,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -136,6 +136,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -167,6 +168,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/apim_v1alpha.projects.locations.operations.html b/docs/dyn/apim_v1alpha.projects.locations.operations.html index 2ae4dc48ba..b92a7a9f6c 100644 --- a/docs/dyn/apim_v1alpha.projects.locations.operations.html +++ b/docs/dyn/apim_v1alpha.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/appengine_v1.apps.locations.html b/docs/dyn/appengine_v1.apps.locations.html index e024b9e17c..b441f68845 100644 --- a/docs/dyn/appengine_v1.apps.locations.html +++ b/docs/dyn/appengine_v1.apps.locations.html @@ -126,7 +126,7 @@

Method Details

Args: appsId: string, Part of `name`. The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/appengine_v1.apps.operations.html b/docs/dyn/appengine_v1.apps.operations.html index e84e4e4bc8..c1dbc54688 100644 --- a/docs/dyn/appengine_v1.apps.operations.html +++ b/docs/dyn/appengine_v1.apps.operations.html @@ -81,7 +81,7 @@

Instance Methods

get(appsId, operationsId, 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.

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

+ list(appsId, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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.

list_next()

@@ -129,7 +129,7 @@

Method Details

- list(appsId, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(appsId, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -137,6 +137,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -168,6 +169,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/appengine_v1.projects.locations.applications.domainMappings.html b/docs/dyn/appengine_v1.projects.locations.applications.domainMappings.html index 5e1e67a87d..be718869f1 100644 --- a/docs/dyn/appengine_v1.projects.locations.applications.domainMappings.html +++ b/docs/dyn/appengine_v1.projects.locations.applications.domainMappings.html @@ -80,9 +80,15 @@

Instance Methods

create(projectsId, locationsId, applicationsId, body=None, overrideStrategy=None, x__xgafv=None)

Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.

+

+ delete(projectsId, locationsId, applicationsId, domainMappingsId, x__xgafv=None)

+

Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.

get(projectsId, locationsId, applicationsId, domainMappingsId, x__xgafv=None)

Gets the specified domain mapping.

+

+ patch(projectsId, locationsId, applicationsId, domainMappingsId, body=None, updateMask=None, x__xgafv=None)

+

Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.

Method Details

close() @@ -151,6 +157,44 @@

Method Details

}
+
+ delete(projectsId, locationsId, applicationsId, domainMappingsId, x__xgafv=None) +
Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.
+
+Args:
+  projectsId: string, Part of `name`. Required. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com. (required)
+  locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  domainMappingsId: string, Part of `name`. See documentation of `projectsId`. (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.
+  },
+}
+
+
get(projectsId, locationsId, applicationsId, domainMappingsId, x__xgafv=None)
Gets the specified domain mapping.
@@ -186,4 +230,63 @@ 

Method Details

}
+
+ patch(projectsId, locationsId, applicationsId, domainMappingsId, body=None, updateMask=None, x__xgafv=None) +
Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.
+
+Args:
+  projectsId: string, Part of `name`. Required. Name of the resource to update. Example: apps/myapp/domainMappings/example.com. (required)
+  locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  domainMappingsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A domain serving an App Engine application.
+  "id": "A String", # Relative name of the domain serving the application. Example: example.com.
+  "name": "A String", # Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
+  "resourceRecords": [ # The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly
+    { # A DNS resource record.
+      "name": "A String", # Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
+      "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
+      "type": "A String", # Resource record type. Example: AAAA.
+    },
+  ],
+  "sslSettings": { # SSL configuration for a DomainMapping resource. # SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
+    "certificateId": "A String", # ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.
+    "pendingManagedCertificateId": "A String", # ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificate_id field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificate_id field with an UpdateDomainMappingRequest.@OutputOnly
+    "sslManagementType": "A String", # SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.
+  },
+}
+
+  updateMask: string, Required. Standard field mask for the set of fields to be updated.
+  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.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/appengine_v1alpha.apps.locations.html b/docs/dyn/appengine_v1alpha.apps.locations.html index 3e914f324c..321e1220ca 100644 --- a/docs/dyn/appengine_v1alpha.apps.locations.html +++ b/docs/dyn/appengine_v1alpha.apps.locations.html @@ -126,7 +126,7 @@

Method Details

Args: appsId: string, Part of `name`. The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/appengine_v1alpha.apps.operations.html b/docs/dyn/appengine_v1alpha.apps.operations.html index 4b601b1881..68bb85be33 100644 --- a/docs/dyn/appengine_v1alpha.apps.operations.html +++ b/docs/dyn/appengine_v1alpha.apps.operations.html @@ -81,7 +81,7 @@

Instance Methods

get(appsId, operationsId, 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.

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

+ list(appsId, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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.

list_next()

@@ -129,7 +129,7 @@

Method Details

- list(appsId, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(appsId, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -137,6 +137,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -168,6 +169,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/appengine_v1alpha.projects.locations.applications.domainMappings.html b/docs/dyn/appengine_v1alpha.projects.locations.applications.domainMappings.html index 8fe28fb36f..f9f78a6534 100644 --- a/docs/dyn/appengine_v1alpha.projects.locations.applications.domainMappings.html +++ b/docs/dyn/appengine_v1alpha.projects.locations.applications.domainMappings.html @@ -80,9 +80,15 @@

Instance Methods

create(projectsId, locationsId, applicationsId, body=None, noManagedCertificate=None, overrideStrategy=None, x__xgafv=None)

Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.

+

+ delete(projectsId, locationsId, applicationsId, domainMappingsId, x__xgafv=None)

+

Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.

get(projectsId, locationsId, applicationsId, domainMappingsId, x__xgafv=None)

Gets the specified domain mapping.

+

+ patch(projectsId, locationsId, applicationsId, domainMappingsId, body=None, noManagedCertificate=None, updateMask=None, x__xgafv=None)

+

Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.

Method Details

close() @@ -151,6 +157,44 @@

Method Details

}
+
+ delete(projectsId, locationsId, applicationsId, domainMappingsId, x__xgafv=None) +
Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.
+
+Args:
+  projectsId: string, Part of `name`. Required. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com. (required)
+  locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  domainMappingsId: string, Part of `name`. See documentation of `projectsId`. (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.
+  },
+}
+
+
get(projectsId, locationsId, applicationsId, domainMappingsId, x__xgafv=None)
Gets the specified domain mapping.
@@ -185,4 +229,63 @@ 

Method Details

}
+
+ patch(projectsId, locationsId, applicationsId, domainMappingsId, body=None, noManagedCertificate=None, updateMask=None, x__xgafv=None) +
Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.
+
+Args:
+  projectsId: string, Part of `name`. Required. Name of the resource to update. Example: apps/myapp/domainMappings/example.com. (required)
+  locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  domainMappingsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A domain serving an App Engine application.
+  "id": "A String", # Relative name of the domain serving the application. Example: example.com.
+  "name": "A String", # Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
+  "resourceRecords": [ # The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly
+    { # A DNS resource record.
+      "name": "A String", # Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
+      "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
+      "type": "A String", # Resource record type. Example: AAAA.
+    },
+  ],
+  "sslSettings": { # SSL configuration for a DomainMapping resource. # SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
+    "certificateId": "A String", # ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify no_managed_certificate on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.
+    "isManagedCertificate": True or False, # Whether the mapped certificate is an App Engine managed certificate. Managed certificates are created by default with a domain mapping. To opt out, specify no_managed_certificate on a CREATE or UPDATE request.@OutputOnly
+  },
+}
+
+  noManagedCertificate: boolean, Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated. Only applicable if ssl_settings.certificate_id is specified in the update mask.
+  updateMask: string, Required. Standard field mask for the set of fields to be updated.
+  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.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/appengine_v1alpha.projects.locations.html b/docs/dyn/appengine_v1alpha.projects.locations.html index d632a7d565..e0e83d0e35 100644 --- a/docs/dyn/appengine_v1alpha.projects.locations.html +++ b/docs/dyn/appengine_v1alpha.projects.locations.html @@ -136,7 +136,7 @@

Method Details

Args: projectsId: string, Part of `name`. The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/appengine_v1alpha.projects.locations.operations.html b/docs/dyn/appengine_v1alpha.projects.locations.operations.html index 86c15520da..a8d6fa4740 100644 --- a/docs/dyn/appengine_v1alpha.projects.locations.operations.html +++ b/docs/dyn/appengine_v1alpha.projects.locations.operations.html @@ -81,7 +81,7 @@

Instance Methods

get(projectsId, locationsId, operationsId, 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.

- list(projectsId, locationsId, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(projectsId, locationsId, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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.

list_next()

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

Method Details

- list(projectsId, locationsId, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(projectsId, locationsId, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -139,6 +139,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -170,6 +171,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/appengine_v1beta.apps.locations.html b/docs/dyn/appengine_v1beta.apps.locations.html index 4d7db2e30d..8b5f55b5af 100644 --- a/docs/dyn/appengine_v1beta.apps.locations.html +++ b/docs/dyn/appengine_v1beta.apps.locations.html @@ -126,7 +126,7 @@

Method Details

Args: appsId: string, Part of `name`. The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/appengine_v1beta.apps.operations.html b/docs/dyn/appengine_v1beta.apps.operations.html index 66810aa5e8..97f26b947f 100644 --- a/docs/dyn/appengine_v1beta.apps.operations.html +++ b/docs/dyn/appengine_v1beta.apps.operations.html @@ -81,7 +81,7 @@

Instance Methods

get(appsId, operationsId, 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.

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

+ list(appsId, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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.

list_next()

@@ -129,7 +129,7 @@

Method Details

- list(appsId, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(appsId, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -137,6 +137,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -168,6 +169,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/appengine_v1beta.projects.locations.applications.domainMappings.html b/docs/dyn/appengine_v1beta.projects.locations.applications.domainMappings.html index a8047d4a0e..8a9817cfe0 100644 --- a/docs/dyn/appengine_v1beta.projects.locations.applications.domainMappings.html +++ b/docs/dyn/appengine_v1beta.projects.locations.applications.domainMappings.html @@ -80,9 +80,15 @@

Instance Methods

create(projectsId, locationsId, applicationsId, body=None, overrideStrategy=None, x__xgafv=None)

Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.

+

+ delete(projectsId, locationsId, applicationsId, domainMappingsId, x__xgafv=None)

+

Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.

get(projectsId, locationsId, applicationsId, domainMappingsId, x__xgafv=None)

Gets the specified domain mapping.

+

+ patch(projectsId, locationsId, applicationsId, domainMappingsId, body=None, updateMask=None, x__xgafv=None)

+

Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.

Method Details

close() @@ -151,6 +157,44 @@

Method Details

}
+
+ delete(projectsId, locationsId, applicationsId, domainMappingsId, x__xgafv=None) +
Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.
+
+Args:
+  projectsId: string, Part of `name`. Required. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com. (required)
+  locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  domainMappingsId: string, Part of `name`. See documentation of `projectsId`. (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.
+  },
+}
+
+
get(projectsId, locationsId, applicationsId, domainMappingsId, x__xgafv=None)
Gets the specified domain mapping.
@@ -186,4 +230,63 @@ 

Method Details

}
+
+ patch(projectsId, locationsId, applicationsId, domainMappingsId, body=None, updateMask=None, x__xgafv=None) +
Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.
+
+Args:
+  projectsId: string, Part of `name`. Required. Name of the resource to update. Example: apps/myapp/domainMappings/example.com. (required)
+  locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  domainMappingsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A domain serving an App Engine application.
+  "id": "A String", # Relative name of the domain serving the application. Example: example.com.
+  "name": "A String", # Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
+  "resourceRecords": [ # The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly
+    { # A DNS resource record.
+      "name": "A String", # Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
+      "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
+      "type": "A String", # Resource record type. Example: AAAA.
+    },
+  ],
+  "sslSettings": { # SSL configuration for a DomainMapping resource. # SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
+    "certificateId": "A String", # ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.
+    "pendingManagedCertificateId": "A String", # ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificate_id field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificate_id field with an UpdateDomainMappingRequest.@OutputOnly
+    "sslManagementType": "A String", # SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.
+  },
+}
+
+  updateMask: string, Required. Standard field mask for the set of fields to be updated.
+  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.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/appengine_v1beta.projects.locations.html b/docs/dyn/appengine_v1beta.projects.locations.html index 25241aee03..9d3d7addac 100644 --- a/docs/dyn/appengine_v1beta.projects.locations.html +++ b/docs/dyn/appengine_v1beta.projects.locations.html @@ -136,7 +136,7 @@

Method Details

Args: projectsId: string, Part of `name`. The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/appengine_v1beta.projects.locations.operations.html b/docs/dyn/appengine_v1beta.projects.locations.operations.html index 753f23ba95..80e90a7192 100644 --- a/docs/dyn/appengine_v1beta.projects.locations.operations.html +++ b/docs/dyn/appengine_v1beta.projects.locations.operations.html @@ -81,7 +81,7 @@

Instance Methods

get(projectsId, locationsId, operationsId, 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.

- list(projectsId, locationsId, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(projectsId, locationsId, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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.

list_next()

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

Method Details

- list(projectsId, locationsId, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(projectsId, locationsId, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -139,6 +139,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -170,6 +171,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/artifactregistry_v1.projects.locations.html b/docs/dyn/artifactregistry_v1.projects.locations.html index e4068d0918..93027574b5 100644 --- a/docs/dyn/artifactregistry_v1.projects.locations.html +++ b/docs/dyn/artifactregistry_v1.projects.locations.html @@ -161,7 +161,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/artifactregistry_v1beta2.projects.locations.html b/docs/dyn/artifactregistry_v1beta2.projects.locations.html index 8cfb89a4e8..6193d36677 100644 --- a/docs/dyn/artifactregistry_v1beta2.projects.locations.html +++ b/docs/dyn/artifactregistry_v1beta2.projects.locations.html @@ -135,7 +135,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index bbd20c887d..080b3c19b2 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -319,10 +319,13 @@

Method Details

}, "timeZone": "A String", # Optional. Default time zone that will apply when parsing timestamp values that have no specific time zone. "timestampFormat": "A String", # Optional. Date format used for parsing TIMESTAMP values. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + 42, + ], "useAvroLogicalTypes": True or False, # Optional. If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). "writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints and uses the schema from the load job. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. }, - "maxSlots": 42, # Optional. INTERNAL: DO NOT USE. The maximum rate of slot consumption to allow for this job. If set, the number of slots used to execute the job will be throttled to try and keep its slot consumption below the requested rate. + "maxSlots": 42, # Optional. A target limit on the rate of slot consumption by this job. If set to a value > 0, BigQuery will attempt to limit the rate of slot consumption by this job to keep it below the configured limit, even if the job is eligible for more slots based on fair scheduling. The unused slots will be available for other jobs and queries to use. Note: This feature is not yet generally available. "query": { # JobConfigurationQuery configures a BigQuery query job. # [Pick one] Configures a query job. "allowLargeResults": false, # Optional. If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For GoogleSQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size. "clustering": { # Configures table clustering. # Clustering specification for the destination table. @@ -551,6 +554,9 @@

Method Details

"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + 42, + ], }, }, "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. @@ -1534,6 +1540,9 @@

Method Details

"quotaDeferments": [ # Output only. Quotas which delayed this job's start time. "A String", ], + "reservationGroupPath": [ # Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservatins info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group. + "A String", + ], "reservationUsage": [ # Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated. { # Job resource usage breakdown by reservation. "name": "A String", # Reservation name or "unreserved" for on-demand resource usage and multi-statement queries. @@ -1823,10 +1832,13 @@

Method Details

}, "timeZone": "A String", # Optional. Default time zone that will apply when parsing timestamp values that have no specific time zone. "timestampFormat": "A String", # Optional. Date format used for parsing TIMESTAMP values. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + 42, + ], "useAvroLogicalTypes": True or False, # Optional. If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). "writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints and uses the schema from the load job. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. }, - "maxSlots": 42, # Optional. INTERNAL: DO NOT USE. The maximum rate of slot consumption to allow for this job. If set, the number of slots used to execute the job will be throttled to try and keep its slot consumption below the requested rate. + "maxSlots": 42, # Optional. A target limit on the rate of slot consumption by this job. If set to a value > 0, BigQuery will attempt to limit the rate of slot consumption by this job to keep it below the configured limit, even if the job is eligible for more slots based on fair scheduling. The unused slots will be available for other jobs and queries to use. Note: This feature is not yet generally available. "query": { # JobConfigurationQuery configures a BigQuery query job. # [Pick one] Configures a query job. "allowLargeResults": false, # Optional. If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For GoogleSQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size. "clustering": { # Configures table clustering. # Clustering specification for the destination table. @@ -2055,6 +2067,9 @@

Method Details

"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + 42, + ], }, }, "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. @@ -3038,6 +3053,9 @@

Method Details

"quotaDeferments": [ # Output only. Quotas which delayed this job's start time. "A String", ], + "reservationGroupPath": [ # Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservatins info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group. + "A String", + ], "reservationUsage": [ # Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated. { # Job resource usage breakdown by reservation. "name": "A String", # Reservation name or "unreserved" for on-demand resource usage and multi-statement queries. @@ -3415,10 +3433,13 @@

Method Details

}, "timeZone": "A String", # Optional. Default time zone that will apply when parsing timestamp values that have no specific time zone. "timestampFormat": "A String", # Optional. Date format used for parsing TIMESTAMP values. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + 42, + ], "useAvroLogicalTypes": True or False, # Optional. If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). "writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints and uses the schema from the load job. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. }, - "maxSlots": 42, # Optional. INTERNAL: DO NOT USE. The maximum rate of slot consumption to allow for this job. If set, the number of slots used to execute the job will be throttled to try and keep its slot consumption below the requested rate. + "maxSlots": 42, # Optional. A target limit on the rate of slot consumption by this job. If set to a value > 0, BigQuery will attempt to limit the rate of slot consumption by this job to keep it below the configured limit, even if the job is eligible for more slots based on fair scheduling. The unused slots will be available for other jobs and queries to use. Note: This feature is not yet generally available. "query": { # JobConfigurationQuery configures a BigQuery query job. # [Pick one] Configures a query job. "allowLargeResults": false, # Optional. If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For GoogleSQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size. "clustering": { # Configures table clustering. # Clustering specification for the destination table. @@ -3647,6 +3668,9 @@

Method Details

"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + 42, + ], }, }, "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. @@ -4630,6 +4654,9 @@

Method Details

"quotaDeferments": [ # Output only. Quotas which delayed this job's start time. "A String", ], + "reservationGroupPath": [ # Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservatins info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group. + "A String", + ], "reservationUsage": [ # Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated. { # Job resource usage breakdown by reservation. "name": "A String", # Reservation name or "unreserved" for on-demand resource usage and multi-statement queries. @@ -4890,10 +4917,13 @@

Method Details

}, "timeZone": "A String", # Optional. Default time zone that will apply when parsing timestamp values that have no specific time zone. "timestampFormat": "A String", # Optional. Date format used for parsing TIMESTAMP values. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + 42, + ], "useAvroLogicalTypes": True or False, # Optional. If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). "writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints and uses the schema from the load job. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. }, - "maxSlots": 42, # Optional. INTERNAL: DO NOT USE. The maximum rate of slot consumption to allow for this job. If set, the number of slots used to execute the job will be throttled to try and keep its slot consumption below the requested rate. + "maxSlots": 42, # Optional. A target limit on the rate of slot consumption by this job. If set to a value > 0, BigQuery will attempt to limit the rate of slot consumption by this job to keep it below the configured limit, even if the job is eligible for more slots based on fair scheduling. The unused slots will be available for other jobs and queries to use. Note: This feature is not yet generally available. "query": { # JobConfigurationQuery configures a BigQuery query job. # [Pick one] Configures a query job. "allowLargeResults": false, # Optional. If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For GoogleSQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size. "clustering": { # Configures table clustering. # Clustering specification for the destination table. @@ -5122,6 +5152,9 @@

Method Details

"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + 42, + ], }, }, "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. @@ -6105,6 +6138,9 @@

Method Details

"quotaDeferments": [ # Output only. Quotas which delayed this job's start time. "A String", ], + "reservationGroupPath": [ # Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservatins info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group. + "A String", + ], "reservationUsage": [ # Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated. { # Job resource usage breakdown by reservation. "name": "A String", # Reservation name or "unreserved" for on-demand resource usage and multi-statement queries. @@ -6388,10 +6424,13 @@

Method Details

}, "timeZone": "A String", # Optional. Default time zone that will apply when parsing timestamp values that have no specific time zone. "timestampFormat": "A String", # Optional. Date format used for parsing TIMESTAMP values. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + 42, + ], "useAvroLogicalTypes": True or False, # Optional. If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). "writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints and uses the schema from the load job. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. }, - "maxSlots": 42, # Optional. INTERNAL: DO NOT USE. The maximum rate of slot consumption to allow for this job. If set, the number of slots used to execute the job will be throttled to try and keep its slot consumption below the requested rate. + "maxSlots": 42, # Optional. A target limit on the rate of slot consumption by this job. If set to a value > 0, BigQuery will attempt to limit the rate of slot consumption by this job to keep it below the configured limit, even if the job is eligible for more slots based on fair scheduling. The unused slots will be available for other jobs and queries to use. Note: This feature is not yet generally available. "query": { # JobConfigurationQuery configures a BigQuery query job. # [Pick one] Configures a query job. "allowLargeResults": false, # Optional. If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For GoogleSQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size. "clustering": { # Configures table clustering. # Clustering specification for the destination table. @@ -6620,6 +6659,9 @@

Method Details

"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + 42, + ], }, }, "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. @@ -7605,6 +7647,9 @@

Method Details

"quotaDeferments": [ # Output only. Quotas which delayed this job's start time. "A String", ], + "reservationGroupPath": [ # Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservatins info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group. + "A String", + ], "reservationUsage": [ # Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated. { # Job resource usage breakdown by reservation. "name": "A String", # Reservation name or "unreserved" for on-demand resource usage and multi-statement queries. @@ -7718,7 +7763,7 @@

Method Details

}, "location": "A String", # The geographic location where the job should run. For more information, see how to [specify locations](https://cloud.google.com/bigquery/docs/locations#specify_locations). "maxResults": 42, # Optional. The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies. - "maxSlots": 42, # Optional. INTERNAL: DO NOT USE. The maximum rate of slot consumption to allow for this job. If set, the number of slots used to execute the job will be throttled to try and keep its slot consumption below the requested rate. This limit is best effort. + "maxSlots": 42, # Optional. A target limit on the rate of slot consumption by this query. If set to a value > 0, BigQuery will attempt to limit the rate of slot consumption by this query to keep it below the configured limit, even if the query is eligible for more slots based on fair scheduling. The unused slots will be available for other jobs and queries to use. Note: This feature is not yet generally available. "maximumBytesBilled": "A String", # Optional. Limits the bytes billed for this query. Queries with bytes billed above this limit will fail (without incurring a charge). If unspecified, the project default is used. "parameterMode": "A String", # GoogleSQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. "preserveNulls": True or False, # This property is deprecated. diff --git a/docs/dyn/bigquery_v2.tables.html b/docs/dyn/bigquery_v2.tables.html index 2d228ef381..4a16a5b953 100644 --- a/docs/dyn/bigquery_v2.tables.html +++ b/docs/dyn/bigquery_v2.tables.html @@ -323,6 +323,9 @@

Method Details

"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + 42, + ], }, "friendlyName": "A String", # Optional. A descriptive name for this table. "id": "A String", # Output only. An opaque ID uniquely identifying the table. @@ -817,6 +820,9 @@

Method Details

"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + 42, + ], }, "friendlyName": "A String", # Optional. A descriptive name for this table. "id": "A String", # Output only. An opaque ID uniquely identifying the table. @@ -1252,6 +1258,9 @@

Method Details

"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + 42, + ], }, "friendlyName": "A String", # Optional. A descriptive name for this table. "id": "A String", # Output only. An opaque ID uniquely identifying the table. @@ -1795,6 +1804,9 @@

Method Details

"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + 42, + ], }, "friendlyName": "A String", # Optional. A descriptive name for this table. "id": "A String", # Output only. An opaque ID uniquely identifying the table. @@ -2231,6 +2243,9 @@

Method Details

"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + 42, + ], }, "friendlyName": "A String", # Optional. A descriptive name for this table. "id": "A String", # Output only. An opaque ID uniquely identifying the table. @@ -2785,6 +2800,9 @@

Method Details

"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + 42, + ], }, "friendlyName": "A String", # Optional. A descriptive name for this table. "id": "A String", # Output only. An opaque ID uniquely identifying the table. @@ -3221,6 +3239,9 @@

Method Details

"timeFormat": "A String", # Optional. Format used to parse TIME values. Supports C-style and SQL-style values. "timeZone": "A String", # Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). "timestampFormat": "A String", # Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. + "timestampTargetPrecision": [ # Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. + 42, + ], }, "friendlyName": "A String", # Optional. A descriptive name for this table. "id": "A String", # Output only. An opaque ID uniquely identifying the table. diff --git a/docs/dyn/certificatemanager_v1.projects.locations.operations.html b/docs/dyn/certificatemanager_v1.projects.locations.operations.html index 17fcdc6881..4a4bf73ee8 100644 --- a/docs/dyn/certificatemanager_v1.projects.locations.operations.html +++ b/docs/dyn/certificatemanager_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/chat_v1.spaces.html b/docs/dyn/chat_v1.spaces.html index e9b0967353..a135b042fa 100644 --- a/docs/dyn/chat_v1.spaces.html +++ b/docs/dyn/chat_v1.spaces.html @@ -172,36 +172,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -248,36 +248,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -323,36 +323,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -423,36 +423,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -505,36 +505,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -591,36 +591,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -683,36 +683,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -759,36 +759,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -847,36 +847,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -960,36 +960,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -1035,36 +1035,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index 8ab69b0c9d..a84fb6cbac 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -2983,36 +2983,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -5912,36 +5912,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -8859,36 +8859,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -11794,36 +11794,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -14734,36 +14734,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -17657,36 +17657,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -20580,36 +20580,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -23503,36 +23503,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html index 3a63d59a25..aa07e24538 100644 --- a/docs/dyn/chat_v1.spaces.spaceEvents.html +++ b/docs/dyn/chat_v1.spaces.spaceEvents.html @@ -3098,36 +3098,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -6016,36 +6016,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -8934,36 +8934,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -11850,36 +11850,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -14764,36 +14764,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -17678,36 +17678,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -17863,36 +17863,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -17932,36 +17932,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -20993,36 +20993,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -23911,36 +23911,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -26829,36 +26829,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -29745,36 +29745,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -32659,36 +32659,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -35573,36 +35573,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -35758,36 +35758,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) @@ -35827,36 +35827,36 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. - "managersAllowed": True or False, # Optional. Whether spaces managers have this permission. - "membersAllowed": True or False, # Optional. Whether non-manager members have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, }, "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) diff --git a/docs/dyn/classroom_v1.courses.html b/docs/dyn/classroom_v1.courses.html index e370cab908..19a17ecb24 100644 --- a/docs/dyn/classroom_v1.courses.html +++ b/docs/dyn/classroom_v1.courses.html @@ -199,7 +199,7 @@

Method Details

"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. - "gradebookSettings": { # The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only + "gradebookSettings": { # The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only. "calculationType": "A String", # Indicates how the overall grade is calculated. "displaySetting": "A String", # Indicates who can see the overall grade.. "gradeCategories": [ # Grade categories that are available for coursework in the course. @@ -275,7 +275,7 @@

Method Details

"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. - "gradebookSettings": { # The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only + "gradebookSettings": { # The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only. "calculationType": "A String", # Indicates how the overall grade is calculated. "displaySetting": "A String", # Indicates who can see the overall grade.. "gradeCategories": [ # Grade categories that are available for coursework in the course. @@ -376,7 +376,7 @@

Method Details

"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. - "gradebookSettings": { # The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only + "gradebookSettings": { # The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only. "calculationType": "A String", # Indicates how the overall grade is calculated. "displaySetting": "A String", # Indicates who can see the overall grade.. "gradeCategories": [ # Grade categories that are available for coursework in the course. @@ -507,7 +507,7 @@

Method Details

"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. - "gradebookSettings": { # The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only + "gradebookSettings": { # The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only. "calculationType": "A String", # Indicates how the overall grade is calculated. "displaySetting": "A String", # Indicates who can see the overall grade.. "gradeCategories": [ # Grade categories that are available for coursework in the course. @@ -602,7 +602,7 @@

Method Details

"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. - "gradebookSettings": { # The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only + "gradebookSettings": { # The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only. "calculationType": "A String", # Indicates how the overall grade is calculated. "displaySetting": "A String", # Indicates who can see the overall grade.. "gradeCategories": [ # Grade categories that are available for coursework in the course. @@ -679,7 +679,7 @@

Method Details

"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. - "gradebookSettings": { # The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only + "gradebookSettings": { # The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only. "calculationType": "A String", # Indicates how the overall grade is calculated. "displaySetting": "A String", # Indicates who can see the overall grade.. "gradeCategories": [ # Grade categories that are available for coursework in the course. @@ -757,7 +757,7 @@

Method Details

"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. - "gradebookSettings": { # The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only + "gradebookSettings": { # The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only. "calculationType": "A String", # Indicates how the overall grade is calculated. "displaySetting": "A String", # Indicates who can see the overall grade.. "gradeCategories": [ # Grade categories that are available for coursework in the course. @@ -833,7 +833,7 @@

Method Details

"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. - "gradebookSettings": { # The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only + "gradebookSettings": { # The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only. "calculationType": "A String", # Indicates how the overall grade is calculated. "displaySetting": "A String", # Indicates who can see the overall grade.. "gradeCategories": [ # Grade categories that are available for coursework in the course. diff --git a/docs/dyn/cloudchannel_v1.operations.html b/docs/dyn/cloudchannel_v1.operations.html index 8aa9e15b8e..d5f2a5a1e3 100644 --- a/docs/dyn/cloudchannel_v1.operations.html +++ b/docs/dyn/cloudchannel_v1.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.operations.html b/docs/dyn/clouddeploy_v1.projects.locations.operations.html index 0b33f4fbcf..abb8b9ba6e 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.operations.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/cloudfunctions_v1.operations.html b/docs/dyn/cloudfunctions_v1.operations.html index 1918bf5be4..d347fc0335 100644 --- a/docs/dyn/cloudfunctions_v1.operations.html +++ b/docs/dyn/cloudfunctions_v1.operations.html @@ -81,7 +81,7 @@

Instance Methods

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.

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

+ list(filter=None, name=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -128,7 +128,7 @@

Method Details

- list(filter=None, name=None, pageSize=None, pageToken=None, x__xgafv=None) + list(filter=None, name=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -136,6 +136,7 @@ 

Method Details

name: string, The name of the operation's parent resource. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -167,6 +168,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/cloudfunctions_v2.projects.locations.operations.html b/docs/dyn/cloudfunctions_v2.projects.locations.operations.html index 779dec301b..e8a1aeffb4 100644 --- a/docs/dyn/cloudfunctions_v2.projects.locations.operations.html +++ b/docs/dyn/cloudfunctions_v2.projects.locations.operations.html @@ -81,7 +81,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -128,7 +128,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -136,6 +136,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -167,6 +168,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/cloudfunctions_v2alpha.projects.locations.operations.html b/docs/dyn/cloudfunctions_v2alpha.projects.locations.operations.html index df480c4ac5..54fdca3ff3 100644 --- a/docs/dyn/cloudfunctions_v2alpha.projects.locations.operations.html +++ b/docs/dyn/cloudfunctions_v2alpha.projects.locations.operations.html @@ -81,7 +81,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -128,7 +128,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -136,6 +136,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -167,6 +168,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/cloudfunctions_v2beta.projects.locations.operations.html b/docs/dyn/cloudfunctions_v2beta.projects.locations.operations.html index c3903dcdb9..80ddc879d7 100644 --- a/docs/dyn/cloudfunctions_v2beta.projects.locations.operations.html +++ b/docs/dyn/cloudfunctions_v2beta.projects.locations.operations.html @@ -81,7 +81,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -128,7 +128,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -136,6 +136,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -167,6 +168,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/cloudkms_v1.folders.html b/docs/dyn/cloudkms_v1.folders.html index 8ebcc7e9a4..6581f5d8c2 100644 --- a/docs/dyn/cloudkms_v1.folders.html +++ b/docs/dyn/cloudkms_v1.folders.html @@ -82,13 +82,13 @@

Instance Methods

Returns the AutokeyConfig for a folder or project.

getKajPolicyConfig(name, x__xgafv=None)

-

Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.

+

Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.

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

Updates the AutokeyConfig for a folder. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.

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

-

Updates the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.

+

Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.

Method Details

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

Method Details

getKajPolicyConfig(name, x__xgafv=None) -
Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.
+  
Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.
 
 Args:
   name: string, Required. The name of the KeyAccessJustificationsPolicyConfig to get. (required)
@@ -176,7 +176,7 @@ 

Method Details

updateKajPolicyConfig(name, body=None, updateMask=None, x__xgafv=None) -
Updates the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.
+  
Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.
 
 Args:
   name: string, Identifier. The resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig". (required)
diff --git a/docs/dyn/cloudkms_v1.organizations.html b/docs/dyn/cloudkms_v1.organizations.html
index b212209926..ce54f87911 100644
--- a/docs/dyn/cloudkms_v1.organizations.html
+++ b/docs/dyn/cloudkms_v1.organizations.html
@@ -79,10 +79,10 @@ 

Instance Methods

Close httplib2 connections.

getKajPolicyConfig(name, x__xgafv=None)

-

Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.

+

Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.

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

-

Updates the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.

+

Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.

Method Details

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

Method Details

getKajPolicyConfig(name, x__xgafv=None) -
Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.
+  
Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.
 
 Args:
   name: string, Required. The name of the KeyAccessJustificationsPolicyConfig to get. (required)
@@ -115,7 +115,7 @@ 

Method Details

updateKajPolicyConfig(name, body=None, updateMask=None, x__xgafv=None) -
Updates the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.
+  
Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.
 
 Args:
   name: string, Identifier. The resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig". (required)
diff --git a/docs/dyn/cloudkms_v1.projects.html b/docs/dyn/cloudkms_v1.projects.html
index a5fe282dad..192fcfb870 100644
--- a/docs/dyn/cloudkms_v1.projects.html
+++ b/docs/dyn/cloudkms_v1.projects.html
@@ -87,7 +87,7 @@ 

Instance Methods

Returns the AutokeyConfig for a folder or project.

getKajPolicyConfig(name, x__xgafv=None)

-

Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.

+

Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.

showEffectiveAutokeyConfig(parent, x__xgafv=None)

Returns the effective Cloud KMS Autokey configuration for a given project.

@@ -102,7 +102,7 @@

Instance Methods

Updates the AutokeyConfig for a folder. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.

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

-

Updates the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.

+

Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.

Method Details

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

Method Details

getKajPolicyConfig(name, x__xgafv=None) -
Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.
+  
Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.
 
 Args:
   name: string, Required. The name of the KeyAccessJustificationsPolicyConfig to get. (required)
@@ -265,7 +265,7 @@ 

Method Details

updateKajPolicyConfig(name, body=None, updateMask=None, x__xgafv=None) -
Updates the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.
+  
Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.
 
 Args:
   name: string, Identifier. The resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig". (required)
diff --git a/docs/dyn/cloudscheduler_v1.projects.locations.operations.html b/docs/dyn/cloudscheduler_v1.projects.locations.operations.html
index 08d36ca6b5..ed7c77edd3 100644
--- a/docs/dyn/cloudscheduler_v1.projects.locations.operations.html
+++ b/docs/dyn/cloudscheduler_v1.projects.locations.operations.html
@@ -87,7 +87,7 @@ 

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/cloudshell_v1.operations.html b/docs/dyn/cloudshell_v1.operations.html index c177616c0b..d44658a8d5 100644 --- a/docs/dyn/cloudshell_v1.operations.html +++ b/docs/dyn/cloudshell_v1.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/composer_v1.projects.locations.operations.html b/docs/dyn/composer_v1.projects.locations.operations.html index c13a703270..1f48ca520f 100644 --- a/docs/dyn/composer_v1.projects.locations.operations.html +++ b/docs/dyn/composer_v1.projects.locations.operations.html @@ -84,7 +84,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -149,7 +149,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -157,6 +157,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -188,6 +189,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/composer_v1beta1.projects.locations.operations.html b/docs/dyn/composer_v1beta1.projects.locations.operations.html index 1bc0a1ac42..0d91ca9dc1 100644 --- a/docs/dyn/composer_v1beta1.projects.locations.operations.html +++ b/docs/dyn/composer_v1beta1.projects.locations.operations.html @@ -84,7 +84,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -149,7 +149,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -157,6 +157,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -188,6 +189,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/config_v1.projects.locations.operations.html b/docs/dyn/config_v1.projects.locations.operations.html index 6a7f779f46..07b34ace84 100644 --- a/docs/dyn/config_v1.projects.locations.operations.html +++ b/docs/dyn/config_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.operations.html b/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.operations.html index 8ce9911e80..1ef0eca000 100644 --- a/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.operations.html +++ b/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html index 729eece899..89924200c0 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.html +++ b/docs/dyn/container_v1.projects.locations.clusters.html @@ -277,7 +277,7 @@

Method Details

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. }, - "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API + "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API. "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. }, "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes @@ -286,8 +286,8 @@

Method Details

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver. "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. }, - "gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver. - "enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster. + "gcpFilestoreCsiDriverConfig": { # Configuration for the Filestore CSI driver. # Configuration for the Filestore CSI driver. + "enabled": True or False, # Whether the Filestore CSI driver is enabled for this cluster. }, "gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver. "enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster. @@ -381,6 +381,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Specifies the upgrade settings for NAP created node pools "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. @@ -432,7 +435,9 @@

Method Details

}, "controlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Configuration for all cluster's control plane endpoints. "dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration. - "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false. + "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that Google-managed services may still use the endpoint even if this is false. + "enableK8sCertsViaDns": True or False, # Controls whether the k8s certs auth is allowed via DNS. + "enableK8sTokensViaDns": True or False, # Controls whether the k8s token auth is allowed via DNS. "endpoint": "A String", # Output only. The cluster's DNS endpoint configuration. A DNS format address. This is accessible from the public internet. Ex: uid.us-central1.gke.goog. Always present, but the behavior may change according to the value of DNSEndpointConfig.allow_external_traffic. }, "ipEndpointsConfig": { # IP endpoints configuration. # IP endpoints configuration. @@ -489,7 +494,7 @@

Method Details

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. - "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. + "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. # GKE Enterprise Configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. "clusterTier": "A String", # Output only. cluster_tier indicates the effective tier of the cluster. "desiredTier": "A String", # desired_tier specifies the desired tier of the cluster. }, @@ -1373,6 +1378,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. @@ -1477,7 +1485,7 @@

Method Details

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, - "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. + "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for the use of Kubernetes Service Accounts in IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. @@ -1680,7 +1688,7 @@

Method Details

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. }, - "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API + "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API. "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. }, "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes @@ -1689,8 +1697,8 @@

Method Details

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver. "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. }, - "gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver. - "enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster. + "gcpFilestoreCsiDriverConfig": { # Configuration for the Filestore CSI driver. # Configuration for the Filestore CSI driver. + "enabled": True or False, # Whether the Filestore CSI driver is enabled for this cluster. }, "gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver. "enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster. @@ -1784,6 +1792,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Specifies the upgrade settings for NAP created node pools "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. @@ -1835,7 +1846,9 @@

Method Details

}, "controlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Configuration for all cluster's control plane endpoints. "dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration. - "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false. + "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that Google-managed services may still use the endpoint even if this is false. + "enableK8sCertsViaDns": True or False, # Controls whether the k8s certs auth is allowed via DNS. + "enableK8sTokensViaDns": True or False, # Controls whether the k8s token auth is allowed via DNS. "endpoint": "A String", # Output only. The cluster's DNS endpoint configuration. A DNS format address. This is accessible from the public internet. Ex: uid.us-central1.gke.goog. Always present, but the behavior may change according to the value of DNSEndpointConfig.allow_external_traffic. }, "ipEndpointsConfig": { # IP endpoints configuration. # IP endpoints configuration. @@ -1892,7 +1905,7 @@

Method Details

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. - "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. + "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. # GKE Enterprise Configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. "clusterTier": "A String", # Output only. cluster_tier indicates the effective tier of the cluster. "desiredTier": "A String", # desired_tier specifies the desired tier of the cluster. }, @@ -2776,6 +2789,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. @@ -2880,7 +2896,7 @@

Method Details

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, - "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. + "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for the use of Kubernetes Service Accounts in IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. @@ -2947,7 +2963,7 @@

Method Details

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. }, - "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API + "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API. "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. }, "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes @@ -2956,8 +2972,8 @@

Method Details

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver. "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. }, - "gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver. - "enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster. + "gcpFilestoreCsiDriverConfig": { # Configuration for the Filestore CSI driver. # Configuration for the Filestore CSI driver. + "enabled": True or False, # Whether the Filestore CSI driver is enabled for this cluster. }, "gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver. "enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster. @@ -3051,6 +3067,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Specifies the upgrade settings for NAP created node pools "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. @@ -3102,7 +3121,9 @@

Method Details

}, "controlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Configuration for all cluster's control plane endpoints. "dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration. - "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false. + "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that Google-managed services may still use the endpoint even if this is false. + "enableK8sCertsViaDns": True or False, # Controls whether the k8s certs auth is allowed via DNS. + "enableK8sTokensViaDns": True or False, # Controls whether the k8s token auth is allowed via DNS. "endpoint": "A String", # Output only. The cluster's DNS endpoint configuration. A DNS format address. This is accessible from the public internet. Ex: uid.us-central1.gke.goog. Always present, but the behavior may change according to the value of DNSEndpointConfig.allow_external_traffic. }, "ipEndpointsConfig": { # IP endpoints configuration. # IP endpoints configuration. @@ -3159,7 +3180,7 @@

Method Details

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. - "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. + "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. # GKE Enterprise Configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. "clusterTier": "A String", # Output only. cluster_tier indicates the effective tier of the cluster. "desiredTier": "A String", # desired_tier specifies the desired tier of the cluster. }, @@ -4043,6 +4064,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. @@ -4147,7 +4171,7 @@

Method Details

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, - "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. + "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for the use of Kubernetes Service Accounts in IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. @@ -4174,7 +4198,7 @@

Method Details

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. }, - "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API + "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API. "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. }, "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes @@ -4183,8 +4207,8 @@

Method Details

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver. "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. }, - "gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver. - "enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster. + "gcpFilestoreCsiDriverConfig": { # Configuration for the Filestore CSI driver. # Configuration for the Filestore CSI driver. + "enabled": True or False, # Whether the Filestore CSI driver is enabled for this cluster. }, "gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver. "enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster. @@ -5081,7 +5105,7 @@

Method Details

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. }, - "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API + "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API. "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. }, "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes @@ -5090,8 +5114,8 @@

Method Details

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver. "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. }, - "gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver. - "enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster. + "gcpFilestoreCsiDriverConfig": { # Configuration for the Filestore CSI driver. # Configuration for the Filestore CSI driver. + "enabled": True or False, # Whether the Filestore CSI driver is enabled for this cluster. }, "gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver. "enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster. @@ -5181,6 +5205,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Specifies the upgrade settings for NAP created node pools "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. @@ -5231,7 +5258,9 @@

Method Details

}, "desiredControlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Control plane endpoints configuration. "dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration. - "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false. + "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that Google-managed services may still use the endpoint even if this is false. + "enableK8sCertsViaDns": True or False, # Controls whether the k8s certs auth is allowed via DNS. + "enableK8sTokensViaDns": True or False, # Controls whether the k8s token auth is allowed via DNS. "endpoint": "A String", # Output only. The cluster's DNS endpoint configuration. A DNS format address. This is accessible from the public internet. Ex: uid.us-central1.gke.goog. Always present, but the behavior may change according to the value of DNSEndpointConfig.allow_external_traffic. }, "ipEndpointsConfig": { # IP endpoints configuration. # IP endpoints configuration. @@ -5288,7 +5317,7 @@

Method Details

"desiredEnableFqdnNetworkPolicy": True or False, # Enable/Disable FQDN Network Policy for the cluster. "desiredEnableMultiNetworking": True or False, # Enable/Disable Multi-Networking for the cluster "desiredEnablePrivateEndpoint": True or False, # Enable/Disable private endpoint for the cluster's master. Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.enable_public_endpoint instead. Note that the value of enable_public_endpoint is reversed: if enable_private_endpoint is false, then enable_public_endpoint will be true. - "desiredEnterpriseConfig": { # DesiredEnterpriseConfig is a wrapper used for updating enterprise_config. # The desired enterprise configuration for the cluster. + "desiredEnterpriseConfig": { # DesiredEnterpriseConfig is a wrapper used for updating enterprise_config. Deprecated: GKE Enterprise features are now available without an Enterprise tier. # The desired enterprise configuration for the cluster. Deprecated: GKE Enterprise features are now available without an Enterprise tier. "desiredTier": "A String", # desired_tier specifies the desired tier of the cluster. }, "desiredFleet": { # Fleet is the fleet configuration for the cluster. # The desired fleet configuration for the cluster. @@ -5592,7 +5621,7 @@

Method Details

"desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, - "desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for Workload Identity. + "desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for Workload Identity. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, "enableK8sBetaApis": { # K8sBetaAPIConfig , configuration for beta APIs # Kubernetes open source beta apis enabled on the cluster. Only beta apis diff --git a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html index 30ef6387b5..0fdc5629ec 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html @@ -470,6 +470,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. @@ -996,6 +999,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. @@ -1349,6 +1355,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. @@ -1878,7 +1887,7 @@

Method Details

"queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "resourceLabels": { # Collection of [GCP labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. + "resourceLabels": { # Collection of [Resource Manager labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "labels": { # Map of node label keys and node label values. "a_key": "A String", }, @@ -1907,6 +1916,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index 0b222652a9..c6011ddc99 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -154,7 +154,7 @@

Method Details

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. }, - "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API + "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API. "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. }, "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes @@ -163,8 +163,8 @@

Method Details

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver. "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. }, - "gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver. - "enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster. + "gcpFilestoreCsiDriverConfig": { # Configuration for the Filestore CSI driver. # Configuration for the Filestore CSI driver. + "enabled": True or False, # Whether the Filestore CSI driver is enabled for this cluster. }, "gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver. "enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster. @@ -375,7 +375,7 @@

Method Details

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. }, - "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API + "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API. "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. }, "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes @@ -384,8 +384,8 @@

Method Details

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver. "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. }, - "gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver. - "enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster. + "gcpFilestoreCsiDriverConfig": { # Configuration for the Filestore CSI driver. # Configuration for the Filestore CSI driver. + "enabled": True or False, # Whether the Filestore CSI driver is enabled for this cluster. }, "gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver. "enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster. @@ -479,6 +479,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Specifies the upgrade settings for NAP created node pools "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. @@ -530,7 +533,9 @@

Method Details

}, "controlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Configuration for all cluster's control plane endpoints. "dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration. - "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false. + "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that Google-managed services may still use the endpoint even if this is false. + "enableK8sCertsViaDns": True or False, # Controls whether the k8s certs auth is allowed via DNS. + "enableK8sTokensViaDns": True or False, # Controls whether the k8s token auth is allowed via DNS. "endpoint": "A String", # Output only. The cluster's DNS endpoint configuration. A DNS format address. This is accessible from the public internet. Ex: uid.us-central1.gke.goog. Always present, but the behavior may change according to the value of DNSEndpointConfig.allow_external_traffic. }, "ipEndpointsConfig": { # IP endpoints configuration. # IP endpoints configuration. @@ -587,7 +592,7 @@

Method Details

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. - "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. + "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. # GKE Enterprise Configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. "clusterTier": "A String", # Output only. cluster_tier indicates the effective tier of the cluster. "desiredTier": "A String", # desired_tier specifies the desired tier of the cluster. }, @@ -1471,6 +1476,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. @@ -1575,7 +1583,7 @@

Method Details

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, - "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. + "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for the use of Kubernetes Service Accounts in IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. @@ -1778,7 +1786,7 @@

Method Details

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. }, - "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API + "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API. "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. }, "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes @@ -1787,8 +1795,8 @@

Method Details

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver. "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. }, - "gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver. - "enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster. + "gcpFilestoreCsiDriverConfig": { # Configuration for the Filestore CSI driver. # Configuration for the Filestore CSI driver. + "enabled": True or False, # Whether the Filestore CSI driver is enabled for this cluster. }, "gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver. "enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster. @@ -1882,6 +1890,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Specifies the upgrade settings for NAP created node pools "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. @@ -1933,7 +1944,9 @@

Method Details

}, "controlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Configuration for all cluster's control plane endpoints. "dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration. - "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false. + "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that Google-managed services may still use the endpoint even if this is false. + "enableK8sCertsViaDns": True or False, # Controls whether the k8s certs auth is allowed via DNS. + "enableK8sTokensViaDns": True or False, # Controls whether the k8s token auth is allowed via DNS. "endpoint": "A String", # Output only. The cluster's DNS endpoint configuration. A DNS format address. This is accessible from the public internet. Ex: uid.us-central1.gke.goog. Always present, but the behavior may change according to the value of DNSEndpointConfig.allow_external_traffic. }, "ipEndpointsConfig": { # IP endpoints configuration. # IP endpoints configuration. @@ -1990,7 +2003,7 @@

Method Details

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. - "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. + "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. # GKE Enterprise Configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. "clusterTier": "A String", # Output only. cluster_tier indicates the effective tier of the cluster. "desiredTier": "A String", # desired_tier specifies the desired tier of the cluster. }, @@ -2874,6 +2887,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. @@ -2978,7 +2994,7 @@

Method Details

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, - "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. + "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for the use of Kubernetes Service Accounts in IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. @@ -3089,7 +3105,7 @@

Method Details

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. }, - "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API + "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API. "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. }, "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes @@ -3098,8 +3114,8 @@

Method Details

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver. "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. }, - "gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver. - "enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster. + "gcpFilestoreCsiDriverConfig": { # Configuration for the Filestore CSI driver. # Configuration for the Filestore CSI driver. + "enabled": True or False, # Whether the Filestore CSI driver is enabled for this cluster. }, "gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver. "enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster. @@ -3193,6 +3209,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Specifies the upgrade settings for NAP created node pools "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. @@ -3244,7 +3263,9 @@

Method Details

}, "controlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Configuration for all cluster's control plane endpoints. "dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration. - "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false. + "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that Google-managed services may still use the endpoint even if this is false. + "enableK8sCertsViaDns": True or False, # Controls whether the k8s certs auth is allowed via DNS. + "enableK8sTokensViaDns": True or False, # Controls whether the k8s token auth is allowed via DNS. "endpoint": "A String", # Output only. The cluster's DNS endpoint configuration. A DNS format address. This is accessible from the public internet. Ex: uid.us-central1.gke.goog. Always present, but the behavior may change according to the value of DNSEndpointConfig.allow_external_traffic. }, "ipEndpointsConfig": { # IP endpoints configuration. # IP endpoints configuration. @@ -3301,7 +3322,7 @@

Method Details

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. - "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. + "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. # GKE Enterprise Configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. "clusterTier": "A String", # Output only. cluster_tier indicates the effective tier of the cluster. "desiredTier": "A String", # desired_tier specifies the desired tier of the cluster. }, @@ -4185,6 +4206,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. @@ -4289,7 +4313,7 @@

Method Details

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, - "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. + "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for the use of Kubernetes Service Accounts in IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. @@ -5108,7 +5132,7 @@

Method Details

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. }, - "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API + "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API. "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. }, "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes @@ -5117,8 +5141,8 @@

Method Details

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver. "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. }, - "gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver. - "enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster. + "gcpFilestoreCsiDriverConfig": { # Configuration for the Filestore CSI driver. # Configuration for the Filestore CSI driver. + "enabled": True or False, # Whether the Filestore CSI driver is enabled for this cluster. }, "gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver. "enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster. @@ -5208,6 +5232,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Specifies the upgrade settings for NAP created node pools "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. @@ -5258,7 +5285,9 @@

Method Details

}, "desiredControlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Control plane endpoints configuration. "dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration. - "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false. + "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that Google-managed services may still use the endpoint even if this is false. + "enableK8sCertsViaDns": True or False, # Controls whether the k8s certs auth is allowed via DNS. + "enableK8sTokensViaDns": True or False, # Controls whether the k8s token auth is allowed via DNS. "endpoint": "A String", # Output only. The cluster's DNS endpoint configuration. A DNS format address. This is accessible from the public internet. Ex: uid.us-central1.gke.goog. Always present, but the behavior may change according to the value of DNSEndpointConfig.allow_external_traffic. }, "ipEndpointsConfig": { # IP endpoints configuration. # IP endpoints configuration. @@ -5315,7 +5344,7 @@

Method Details

"desiredEnableFqdnNetworkPolicy": True or False, # Enable/Disable FQDN Network Policy for the cluster. "desiredEnableMultiNetworking": True or False, # Enable/Disable Multi-Networking for the cluster "desiredEnablePrivateEndpoint": True or False, # Enable/Disable private endpoint for the cluster's master. Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.enable_public_endpoint instead. Note that the value of enable_public_endpoint is reversed: if enable_private_endpoint is false, then enable_public_endpoint will be true. - "desiredEnterpriseConfig": { # DesiredEnterpriseConfig is a wrapper used for updating enterprise_config. # The desired enterprise configuration for the cluster. + "desiredEnterpriseConfig": { # DesiredEnterpriseConfig is a wrapper used for updating enterprise_config. Deprecated: GKE Enterprise features are now available without an Enterprise tier. # The desired enterprise configuration for the cluster. Deprecated: GKE Enterprise features are now available without an Enterprise tier. "desiredTier": "A String", # desired_tier specifies the desired tier of the cluster. }, "desiredFleet": { # Fleet is the fleet configuration for the cluster. # The desired fleet configuration for the cluster. @@ -5619,7 +5648,7 @@

Method Details

"desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, - "desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for Workload Identity. + "desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for Workload Identity. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, "enableK8sBetaApis": { # K8sBetaAPIConfig , configuration for beta APIs # Kubernetes open source beta apis enabled on the cluster. Only beta apis diff --git a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html index 0ea5d1016e..f9e49250a1 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html @@ -535,6 +535,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. @@ -1061,6 +1064,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. @@ -1414,6 +1420,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. @@ -1868,7 +1877,7 @@

Method Details

"queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "resourceLabels": { # Collection of [GCP labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. + "resourceLabels": { # Collection of [Resource Manager labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "labels": { # Map of node label keys and node label values. "a_key": "A String", }, @@ -1897,6 +1906,9 @@

Method Details

}, "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. + "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. + }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. "batchNodeCount": 42, # Number of blue nodes to drain in a batch. diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index 17692da0f5..ecdb88346a 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -392,6 +392,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. @@ -1437,6 +1438,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. @@ -1883,6 +1885,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. @@ -2928,6 +2931,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. @@ -3238,6 +3242,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. @@ -4283,6 +4288,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. @@ -5465,6 +5471,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html index 52fcb0039d..4e0f0bb345 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html @@ -486,6 +486,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. @@ -1029,6 +1030,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. @@ -1399,6 +1401,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. @@ -1961,6 +1964,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index 82d23d0141..6b5d3e38a3 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -497,6 +497,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. @@ -1542,6 +1543,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. @@ -1988,6 +1990,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. @@ -3033,6 +3036,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. @@ -3387,6 +3391,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. @@ -4432,6 +4437,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. @@ -5492,6 +5498,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html index 00b1707794..50405bb9df 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html @@ -551,6 +551,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. @@ -1094,6 +1095,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. @@ -1464,6 +1466,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. @@ -1951,6 +1954,7 @@

Method Details

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade. "blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy. "autoscaledRolloutPolicy": { # Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade. + "waitForDrainDuration": "A String", # Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. }, "nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. "standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade. diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.notes.html b/docs/dyn/containeranalysis_v1alpha1.projects.notes.html index a65522f96f..785641febf 100644 --- a/docs/dyn/containeranalysis_v1alpha1.projects.notes.html +++ b/docs/dyn/containeranalysis_v1alpha1.projects.notes.html @@ -393,6 +393,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -713,6 +714,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -1056,6 +1058,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -1431,6 +1434,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -1767,6 +1771,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -2086,6 +2091,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.notes.occurrences.html b/docs/dyn/containeranalysis_v1alpha1.projects.notes.occurrences.html index c418f07ad6..65ba5cee34 100644 --- a/docs/dyn/containeranalysis_v1alpha1.projects.notes.occurrences.html +++ b/docs/dyn/containeranalysis_v1alpha1.projects.notes.occurrences.html @@ -853,6 +853,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -975,6 +976,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -1004,6 +1006,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html b/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html index f32f78add1..6cb5bffdfc 100644 --- a/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html +++ b/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html @@ -869,6 +869,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -991,6 +992,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -1020,6 +1022,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -1835,6 +1838,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -1957,6 +1961,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -1986,6 +1991,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -2825,6 +2831,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -2947,6 +2954,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -2976,6 +2984,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -3365,6 +3374,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -4217,6 +4227,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -4339,6 +4350,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -4368,6 +4380,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -5200,6 +5213,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -5322,6 +5336,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -5351,6 +5366,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -6166,6 +6182,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -6288,6 +6305,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -6317,6 +6335,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. diff --git a/docs/dyn/containeranalysis_v1alpha1.providers.notes.html b/docs/dyn/containeranalysis_v1alpha1.providers.notes.html index 2fb7fa6711..4e8c203771 100644 --- a/docs/dyn/containeranalysis_v1alpha1.providers.notes.html +++ b/docs/dyn/containeranalysis_v1alpha1.providers.notes.html @@ -393,6 +393,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -713,6 +714,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -1056,6 +1058,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -1431,6 +1434,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -1767,6 +1771,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -2086,6 +2091,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. diff --git a/docs/dyn/containeranalysis_v1alpha1.providers.notes.occurrences.html b/docs/dyn/containeranalysis_v1alpha1.providers.notes.occurrences.html index 719bc069a3..d0ed30e9bd 100644 --- a/docs/dyn/containeranalysis_v1alpha1.providers.notes.occurrences.html +++ b/docs/dyn/containeranalysis_v1alpha1.providers.notes.occurrences.html @@ -853,6 +853,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -975,6 +976,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. @@ -1004,6 +1006,7 @@

Method Details

"repository": "A String", # The repository name in which the base image is from. }, ], + "chainId": "A String", # The chain ID of the layer in the container image. "command": "A String", # The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. "diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. diff --git a/docs/dyn/dataplex_v1.organizations.locations.encryptionConfigs.html b/docs/dyn/dataplex_v1.organizations.locations.encryptionConfigs.html index 949edb8590..8d5e324848 100644 --- a/docs/dyn/dataplex_v1.organizations.locations.encryptionConfigs.html +++ b/docs/dyn/dataplex_v1.organizations.locations.encryptionConfigs.html @@ -121,6 +121,7 @@

Method Details

{ # A Resource designed to manage encryption configurations for customers to support Customer Managed Encryption Keys (CMEK). "createTime": "A String", # Output only. The time when the Encryption configuration was created. + "enableMetastoreEncryption": True or False, # Optional. Represent the state of CMEK opt-in for metastore. "encryptionState": "A String", # Output only. The state of encryption of the databases. "etag": "A String", # Etag of the EncryptionConfig. This is a strong etag. "failureDetails": { # Details of the failure if anything related to Cmek db fails. # Output only. Details of the failure if anything related to Cmek db fails. @@ -214,6 +215,7 @@

Method Details

{ # A Resource designed to manage encryption configurations for customers to support Customer Managed Encryption Keys (CMEK). "createTime": "A String", # Output only. The time when the Encryption configuration was created. + "enableMetastoreEncryption": True or False, # Optional. Represent the state of CMEK opt-in for metastore. "encryptionState": "A String", # Output only. The state of encryption of the databases. "etag": "A String", # Etag of the EncryptionConfig. This is a strong etag. "failureDetails": { # Details of the failure if anything related to Cmek db fails. # Output only. Details of the failure if anything related to Cmek db fails. @@ -296,6 +298,7 @@

Method Details

"encryptionConfigs": [ # The list of EncryptionConfigs under the given parent location. { # A Resource designed to manage encryption configurations for customers to support Customer Managed Encryption Keys (CMEK). "createTime": "A String", # Output only. The time when the Encryption configuration was created. + "enableMetastoreEncryption": True or False, # Optional. Represent the state of CMEK opt-in for metastore. "encryptionState": "A String", # Output only. The state of encryption of the databases. "etag": "A String", # Etag of the EncryptionConfig. This is a strong etag. "failureDetails": { # Details of the failure if anything related to Cmek db fails. # Output only. Details of the failure if anything related to Cmek db fails. @@ -339,6 +342,7 @@

Method Details

{ # A Resource designed to manage encryption configurations for customers to support Customer Managed Encryption Keys (CMEK). "createTime": "A String", # Output only. The time when the Encryption configuration was created. + "enableMetastoreEncryption": True or False, # Optional. Represent the state of CMEK opt-in for metastore. "encryptionState": "A String", # Output only. The state of encryption of the databases. "etag": "A String", # Etag of the EncryptionConfig. This is a strong etag. "failureDetails": { # Details of the failure if anything related to Cmek db fails. # Output only. Details of the failure if anything related to Cmek db fails. diff --git a/docs/dyn/dataplex_v1.organizations.locations.operations.html b/docs/dyn/dataplex_v1.organizations.locations.operations.html index a8fb552065..63917aca5c 100644 --- a/docs/dyn/dataplex_v1.organizations.locations.operations.html +++ b/docs/dyn/dataplex_v1.organizations.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/dataplex_v1.projects.locations.changeRequests.html b/docs/dyn/dataplex_v1.projects.locations.changeRequests.html new file mode 100644 index 0000000000..40d72cb394 --- /dev/null +++ b/docs/dyn/dataplex_v1.projects.locations.changeRequests.html @@ -0,0 +1,258 @@ + + + +

Cloud Dataplex API . projects . locations . changeRequests

+

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.dataScans.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.html index 742dc08d3e..ba3de60f20 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.html @@ -182,7 +182,7 @@

Method Details

}, "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of a data documentation scan. "tableResult": { # Generated metadata about the table. # Output only. Table result for insights. - "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID "overview": "A String", # Output only. Generated description of the table. "queries": [ # Output only. Sample SQL queries for the table. { # A sample SQL query in data documentation. @@ -686,7 +686,7 @@

Method Details

}, "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of a data documentation scan. "tableResult": { # Generated metadata about the table. # Output only. Table result for insights. - "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID "overview": "A String", # Output only. Generated description of the table. "queries": [ # Output only. Sample SQL queries for the table. { # A sample SQL query in data documentation. @@ -1104,7 +1104,7 @@

Method Details

}, "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of a data documentation scan. "tableResult": { # Generated metadata about the table. # Output only. Table result for insights. - "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID "overview": "A String", # Output only. Generated description of the table. "queries": [ # Output only. Sample SQL queries for the table. { # A sample SQL query in data documentation. @@ -1483,7 +1483,7 @@

Method Details

}, "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of a data documentation scan. "tableResult": { # Generated metadata about the table. # Output only. Table result for insights. - "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID "overview": "A String", # Output only. Generated description of the table. "queries": [ # Output only. Sample SQL queries for the table. { # A sample SQL query in data documentation. @@ -1880,7 +1880,7 @@

Method Details

}, "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of a data documentation scan. "tableResult": { # Generated metadata about the table. # Output only. Table result for insights. - "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID "overview": "A String", # Output only. Generated description of the table. "queries": [ # Output only. Sample SQL queries for the table. { # A sample SQL query in data documentation. diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html index 6671b13a37..297efe2992 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html @@ -231,7 +231,7 @@

Method Details

}, "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of a data documentation scan. "tableResult": { # Generated metadata about the table. # Output only. Table result for insights. - "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID "overview": "A String", # Output only. Generated description of the table. "queries": [ # Output only. Sample SQL queries for the table. { # A sample SQL query in data documentation. @@ -578,7 +578,7 @@

Method Details

}, "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of a data documentation scan. "tableResult": { # Generated metadata about the table. # Output only. Table result for insights. - "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID "overview": "A String", # Output only. Generated description of the table. "queries": [ # Output only. Sample SQL queries for the table. { # A sample SQL query in data documentation. diff --git a/docs/dyn/dataplex_v1.projects.locations.html b/docs/dyn/dataplex_v1.projects.locations.html index 82aff3696f..966d1f33f3 100644 --- a/docs/dyn/dataplex_v1.projects.locations.html +++ b/docs/dyn/dataplex_v1.projects.locations.html @@ -79,6 +79,11 @@

Instance Methods

Returns the aspectTypes Resource.

+

+ changeRequests() +

+

Returns the changeRequests Resource.

+

dataAttributeBindings()

diff --git a/docs/dyn/dataplex_v1.projects.locations.operations.html b/docs/dyn/dataplex_v1.projects.locations.operations.html index 7ca9469c07..7b7b7dee76 100644 --- a/docs/dyn/dataplex_v1.projects.locations.operations.html +++ b/docs/dyn/dataplex_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/dataproc_v1.projects.locations.batches.html b/docs/dyn/dataproc_v1.projects.locations.batches.html index 230068ff8d..682fe1f0ba 100644 --- a/docs/dyn/dataproc_v1.projects.locations.batches.html +++ b/docs/dyn/dataproc_v1.projects.locations.batches.html @@ -230,7 +230,6 @@

Method Details

"acceleratorType": "A String", # Optional. Accelerator type being used, if any "milliAcceleratorSeconds": "A String", # Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuSeconds": "A String", # Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). - "milliSlotSeconds": "A String", # Optional. Slot usage in (milliSlot x seconds). "shuffleStorageGbSeconds": "A String", # Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "updateTime": "A String", # Optional. The timestamp of the usage metrics. }, @@ -239,7 +238,6 @@

Method Details

"milliAccelerator": "A String", # Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "milliDcu": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuPremium": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) charged at premium tier (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). - "milliSlot": "A String", # Optional. Milli (one-thousandth) Slot usage of the workload. "shuffleStorageGb": "A String", # Optional. Shuffle Storage in gigabytes (GB). (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "shuffleStorageGbPremium": "A String", # Optional. Shuffle Storage in gigabytes (GB) charged at premium tier. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "snapshotTime": "A String", # Optional. The timestamp of the usage snapshot. @@ -444,7 +442,6 @@

Method Details

"acceleratorType": "A String", # Optional. Accelerator type being used, if any "milliAcceleratorSeconds": "A String", # Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuSeconds": "A String", # Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). - "milliSlotSeconds": "A String", # Optional. Slot usage in (milliSlot x seconds). "shuffleStorageGbSeconds": "A String", # Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "updateTime": "A String", # Optional. The timestamp of the usage metrics. }, @@ -453,7 +450,6 @@

Method Details

"milliAccelerator": "A String", # Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "milliDcu": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuPremium": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) charged at premium tier (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). - "milliSlot": "A String", # Optional. Milli (one-thousandth) Slot usage of the workload. "shuffleStorageGb": "A String", # Optional. Shuffle Storage in gigabytes (GB). (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "shuffleStorageGbPremium": "A String", # Optional. Shuffle Storage in gigabytes (GB) charged at premium tier. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "snapshotTime": "A String", # Optional. The timestamp of the usage snapshot. @@ -616,7 +612,6 @@

Method Details

"acceleratorType": "A String", # Optional. Accelerator type being used, if any "milliAcceleratorSeconds": "A String", # Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuSeconds": "A String", # Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). - "milliSlotSeconds": "A String", # Optional. Slot usage in (milliSlot x seconds). "shuffleStorageGbSeconds": "A String", # Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "updateTime": "A String", # Optional. The timestamp of the usage metrics. }, @@ -625,7 +620,6 @@

Method Details

"milliAccelerator": "A String", # Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "milliDcu": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuPremium": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) charged at premium tier (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). - "milliSlot": "A String", # Optional. Milli (one-thousandth) Slot usage of the workload. "shuffleStorageGb": "A String", # Optional. Shuffle Storage in gigabytes (GB). (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "shuffleStorageGbPremium": "A String", # Optional. Shuffle Storage in gigabytes (GB) charged at premium tier. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "snapshotTime": "A String", # Optional. The timestamp of the usage snapshot. diff --git a/docs/dyn/dataproc_v1.projects.locations.sessions.html b/docs/dyn/dataproc_v1.projects.locations.sessions.html index 229aa6b8ee..ad0a9325f7 100644 --- a/docs/dyn/dataproc_v1.projects.locations.sessions.html +++ b/docs/dyn/dataproc_v1.projects.locations.sessions.html @@ -172,7 +172,6 @@

Method Details

"acceleratorType": "A String", # Optional. Accelerator type being used, if any "milliAcceleratorSeconds": "A String", # Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuSeconds": "A String", # Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). - "milliSlotSeconds": "A String", # Optional. Slot usage in (milliSlot x seconds). "shuffleStorageGbSeconds": "A String", # Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "updateTime": "A String", # Optional. The timestamp of the usage metrics. }, @@ -181,7 +180,6 @@

Method Details

"milliAccelerator": "A String", # Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "milliDcu": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuPremium": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) charged at premium tier (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). - "milliSlot": "A String", # Optional. Milli (one-thousandth) Slot usage of the workload. "shuffleStorageGb": "A String", # Optional. Shuffle Storage in gigabytes (GB). (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "shuffleStorageGbPremium": "A String", # Optional. Shuffle Storage in gigabytes (GB) charged at premium tier. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "snapshotTime": "A String", # Optional. The timestamp of the usage snapshot. @@ -356,7 +354,6 @@

Method Details

"acceleratorType": "A String", # Optional. Accelerator type being used, if any "milliAcceleratorSeconds": "A String", # Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuSeconds": "A String", # Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). - "milliSlotSeconds": "A String", # Optional. Slot usage in (milliSlot x seconds). "shuffleStorageGbSeconds": "A String", # Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "updateTime": "A String", # Optional. The timestamp of the usage metrics. }, @@ -365,7 +362,6 @@

Method Details

"milliAccelerator": "A String", # Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "milliDcu": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuPremium": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) charged at premium tier (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). - "milliSlot": "A String", # Optional. Milli (one-thousandth) Slot usage of the workload. "shuffleStorageGb": "A String", # Optional. Shuffle Storage in gigabytes (GB). (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "shuffleStorageGbPremium": "A String", # Optional. Shuffle Storage in gigabytes (GB) charged at premium tier. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "snapshotTime": "A String", # Optional. The timestamp of the usage snapshot. @@ -480,7 +476,6 @@

Method Details

"acceleratorType": "A String", # Optional. Accelerator type being used, if any "milliAcceleratorSeconds": "A String", # Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuSeconds": "A String", # Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). - "milliSlotSeconds": "A String", # Optional. Slot usage in (milliSlot x seconds). "shuffleStorageGbSeconds": "A String", # Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "updateTime": "A String", # Optional. The timestamp of the usage metrics. }, @@ -489,7 +484,6 @@

Method Details

"milliAccelerator": "A String", # Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "milliDcu": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuPremium": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) charged at premium tier (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). - "milliSlot": "A String", # Optional. Milli (one-thousandth) Slot usage of the workload. "shuffleStorageGb": "A String", # Optional. Shuffle Storage in gigabytes (GB). (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "shuffleStorageGbPremium": "A String", # Optional. Shuffle Storage in gigabytes (GB) charged at premium tier. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "snapshotTime": "A String", # Optional. The timestamp of the usage snapshot. diff --git a/docs/dyn/dataproc_v1.projects.regions.clusters.html b/docs/dyn/dataproc_v1.projects.regions.clusters.html index f2c289a77b..7aea88443e 100644 --- a/docs/dyn/dataproc_v1.projects.regions.clusters.html +++ b/docs/dyn/dataproc_v1.projects.regions.clusters.html @@ -2518,6 +2518,7 @@

Method Details

"clusterRepairAction": "A String", # Required. Repair action to take on the cluster resource. }, "clusterUuid": "A String", # Optional. Specifying the cluster_uuid means the RPC will fail (with error NOT_FOUND) if a cluster with the specified UUID does not exist. + "dataprocSuperUser": True or False, # Optional. Whether the request is submitted by Dataproc super user. If true, IAM will check 'dataproc.clusters.repair' permission instead of 'dataproc.clusters.update' permission. This is to give Dataproc superuser the ability to repair clusters without granting the overly broad update permission. "gracefulDecommissionTimeout": "A String", # Optional. Timeout for graceful YARN decommissioning. Graceful decommissioning facilitates the removal of cluster nodes without interrupting jobs in progress. The timeout specifies the amount of time to wait for jobs finish before forcefully removing nodes. The default timeout is 0 for forceful decommissioning, and the maximum timeout period is 1 day. (see JSON Mapping—Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).graceful_decommission_timeout is supported in Dataproc image versions 1.2+. "nodePools": [ # Optional. Node pools and corresponding repair action to be taken. All node pools should be unique in this request. i.e. Multiple entries for the same node pool id are not allowed. { # indicating a list of workers of same type diff --git a/docs/dyn/developerconnect_v1.projects.locations.operations.html b/docs/dyn/developerconnect_v1.projects.locations.operations.html index 44e008108d..8f5cfb58b2 100644 --- a/docs/dyn/developerconnect_v1.projects.locations.operations.html +++ b/docs/dyn/developerconnect_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/dialogflow_v2.projects.answerRecords.html b/docs/dyn/dialogflow_v2.projects.answerRecords.html index a16693b7ab..252ad2bde0 100644 --- a/docs/dyn/dialogflow_v2.projects.answerRecords.html +++ b/docs/dyn/dialogflow_v2.projects.answerRecords.html @@ -600,6 +600,74 @@

Method Details

"source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. }, "generatorSuggestion": { # Suggestion generated using a Generator. # Output only. The generator suggestion. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -615,14 +683,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -1186,6 +1259,74 @@

Method Details

"source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. }, "generatorSuggestion": { # Suggestion generated using a Generator. # Output only. The generator suggestion. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -1201,14 +1342,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -1754,6 +1900,74 @@

Method Details

"source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. }, "generatorSuggestion": { # Suggestion generated using a Generator. # Output only. The generator suggestion. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -1769,14 +1983,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. diff --git a/docs/dyn/dialogflow_v2.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html index 17862150d6..cda17bf260 100644 --- a/docs/dyn/dialogflow_v2.projects.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html @@ -169,6 +169,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -183,6 +184,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -214,6 +216,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -227,9 +237,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -244,6 +257,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -275,6 +289,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -288,6 +310,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -380,6 +404,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -394,6 +419,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -425,6 +451,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -438,9 +472,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -455,6 +492,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -486,6 +524,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -499,6 +545,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -616,6 +664,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -630,6 +679,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -661,6 +711,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -674,9 +732,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -691,6 +752,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -722,6 +784,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -735,6 +805,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -838,6 +910,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -852,6 +925,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -883,6 +957,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -896,9 +978,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -913,6 +998,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -944,6 +1030,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -957,6 +1051,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -1068,6 +1164,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1082,6 +1179,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1113,6 +1211,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -1126,9 +1232,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1143,6 +1252,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1174,6 +1284,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -1187,6 +1305,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -1280,6 +1400,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1294,6 +1415,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1325,6 +1447,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -1338,9 +1468,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1355,6 +1488,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1386,6 +1520,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -1399,6 +1541,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -1498,6 +1642,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1529,6 +1674,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, diff --git a/docs/dyn/dialogflow_v2.projects.conversations.html b/docs/dyn/dialogflow_v2.projects.conversations.html index a7f6dd8500..dfdb971135 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.html @@ -141,6 +141,7 @@

Method Details

"a_key": { # Represents a section of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -194,6 +195,7 @@

Method Details

"a_key": { # Represents a section of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -246,6 +248,7 @@

Method Details

"a_key": { # Represents a section of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -304,6 +307,7 @@

Method Details

"a_key": { # Represents a section of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -367,6 +371,7 @@

Method Details

"a_key": { # Represents a section of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. diff --git a/docs/dyn/dialogflow_v2.projects.conversations.participants.html b/docs/dyn/dialogflow_v2.projects.conversations.participants.html index 66289063ae..95006138f4 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.participants.html @@ -220,8 +220,13 @@

Method Details

}, }, "requestId": "A String", # A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided. - "suggestionInput": { # Represents the selection of a suggestion. # An input representing the selection of a suggestion. - "answerRecord": "A String", # Required. The ID of a suggestion selected by the human agent. The suggestion(s) were generated in a previous call to request Dialogflow assist. The format is: `projects//locations//answerRecords/` where is an alphanumeric string. + "suggestionInput": { # Represents the action to take for a tool call that requires confirmation. # An input representing the selection of a suggestion. + "action": "A String", # Optional. The type of action to take with the tool. + "answerRecord": "A String", # Required. Format: `projects//locations//answerRecords/` The answer record associated with the tool call. + "parameters": { # Optional. Parameters to be used for the tool call. If not provided, the tool will be called without any parameters. + "a_key": "", # Properties of the object. + }, + "sendTime": "A String", # Optional. Time when the current suggest input is sent. For tool calls, this timestamp (along with the answer record) will be included in the corresponding tool call result so that it can be identified. }, "textInput": { # Auxiliary proto messages. Represents the natural language text to be processed. # The natural language text to be processed. "languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. @@ -754,6 +759,74 @@

Method Details

{ # A GeneratorSuggestion answer. "answerRecord": "A String", # Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback. "generatorSuggestion": { # Suggestion generated using a Generator. # Suggestion details. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -769,14 +842,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -884,6 +962,74 @@

Method Details

{ # A GeneratorSuggestion answer. "answerRecord": "A String", # Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback. "generatorSuggestion": { # Suggestion generated using a Generator. # Suggestion details. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -899,14 +1045,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. diff --git a/docs/dyn/dialogflow_v2.projects.conversations.suggestions.html b/docs/dyn/dialogflow_v2.projects.conversations.suggestions.html index 9f5b2d0c1b..1f6cc9935f 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.suggestions.html @@ -121,6 +121,74 @@

Method Details

{ # A GeneratorSuggestion answer. "answerRecord": "A String", # Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback. "generatorSuggestion": { # Suggestion generated using a Generator. # Suggestion details. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -136,14 +204,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. diff --git a/docs/dyn/dialogflow_v2.projects.generators.html b/docs/dyn/dialogflow_v2.projects.generators.html index e6880737ae..fe109b8ef6 100644 --- a/docs/dyn/dialogflow_v2.projects.generators.html +++ b/docs/dyn/dialogflow_v2.projects.generators.html @@ -102,6 +102,29 @@

Method Details

The object takes the form of: { # LLM generator. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of prebuilt Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["1.2"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -115,6 +138,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of prebuilt Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -132,6 +159,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -147,14 +242,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -204,6 +304,29 @@

Method Details

An object of the form: { # LLM generator. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of prebuilt Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["1.2"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -217,6 +340,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of prebuilt Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -234,6 +361,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -249,14 +444,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -316,6 +516,29 @@

Method Details

{ # Response of ListGenerators. "generators": [ # List of generators retrieved. { # LLM generator. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of prebuilt Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["1.2"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -329,6 +552,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of prebuilt Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -346,6 +573,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -361,14 +656,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. diff --git a/docs/dyn/dialogflow_v2.projects.locations.answerRecords.html b/docs/dyn/dialogflow_v2.projects.locations.answerRecords.html index b0dfac2e2f..89a1a5f01f 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.answerRecords.html +++ b/docs/dyn/dialogflow_v2.projects.locations.answerRecords.html @@ -600,6 +600,74 @@

Method Details

"source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. }, "generatorSuggestion": { # Suggestion generated using a Generator. # Output only. The generator suggestion. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -615,14 +683,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -1186,6 +1259,74 @@

Method Details

"source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. }, "generatorSuggestion": { # Suggestion generated using a Generator. # Output only. The generator suggestion. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -1201,14 +1342,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -1754,6 +1900,74 @@

Method Details

"source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. }, "generatorSuggestion": { # Suggestion generated using a Generator. # Output only. The generator suggestion. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -1769,14 +1983,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html index 36d3937bac..205d15939f 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html @@ -169,6 +169,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -183,6 +184,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -214,6 +216,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -227,9 +237,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -244,6 +257,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -275,6 +289,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -288,6 +310,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -380,6 +404,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -394,6 +419,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -425,6 +451,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -438,9 +472,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -455,6 +492,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -486,6 +524,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -499,6 +545,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -616,6 +664,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -630,6 +679,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -661,6 +711,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -674,9 +732,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -691,6 +752,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -722,6 +784,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -735,6 +805,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -838,6 +910,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -852,6 +925,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -883,6 +957,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -896,9 +978,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -913,6 +998,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -944,6 +1030,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -957,6 +1051,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -1068,6 +1164,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1082,6 +1179,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1113,6 +1211,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -1126,9 +1232,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1143,6 +1252,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1174,6 +1284,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -1187,6 +1305,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -1280,6 +1400,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1294,6 +1415,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1325,6 +1447,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -1338,9 +1468,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1355,6 +1488,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1386,6 +1520,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -1399,6 +1541,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -1498,6 +1642,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1529,6 +1674,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.html index 2333956650..0abfe8a026 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.html @@ -144,6 +144,7 @@

Method Details

"a_key": { # Represents a section of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -197,6 +198,7 @@

Method Details

"a_key": { # Represents a section of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -249,6 +251,7 @@

Method Details

"a_key": { # Represents a section of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -307,6 +310,7 @@

Method Details

"a_key": { # Represents a section of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -357,6 +361,7 @@

Method Details

"a_key": { # Represents a section of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -382,6 +387,7 @@

Method Details

"a_key": { # Represents a section of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -422,6 +428,7 @@

Method Details

"a_key": { # Represents a section of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html index 88cc822774..9dd3715a88 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html @@ -220,8 +220,13 @@

Method Details

}, }, "requestId": "A String", # A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided. - "suggestionInput": { # Represents the selection of a suggestion. # An input representing the selection of a suggestion. - "answerRecord": "A String", # Required. The ID of a suggestion selected by the human agent. The suggestion(s) were generated in a previous call to request Dialogflow assist. The format is: `projects//locations//answerRecords/` where is an alphanumeric string. + "suggestionInput": { # Represents the action to take for a tool call that requires confirmation. # An input representing the selection of a suggestion. + "action": "A String", # Optional. The type of action to take with the tool. + "answerRecord": "A String", # Required. Format: `projects//locations//answerRecords/` The answer record associated with the tool call. + "parameters": { # Optional. Parameters to be used for the tool call. If not provided, the tool will be called without any parameters. + "a_key": "", # Properties of the object. + }, + "sendTime": "A String", # Optional. Time when the current suggest input is sent. For tool calls, this timestamp (along with the answer record) will be included in the corresponding tool call result so that it can be identified. }, "textInput": { # Auxiliary proto messages. Represents the natural language text to be processed. # The natural language text to be processed. "languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. @@ -754,6 +759,74 @@

Method Details

{ # A GeneratorSuggestion answer. "answerRecord": "A String", # Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback. "generatorSuggestion": { # Suggestion generated using a Generator. # Suggestion details. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -769,14 +842,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -884,6 +962,74 @@

Method Details

{ # A GeneratorSuggestion answer. "answerRecord": "A String", # Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback. "generatorSuggestion": { # Suggestion generated using a Generator. # Suggestion details. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -899,14 +1045,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.suggestions.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.suggestions.html index 8a72c851a4..c12a72c018 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.suggestions.html @@ -121,6 +121,74 @@

Method Details

{ # A GeneratorSuggestion answer. "answerRecord": "A String", # Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback. "generatorSuggestion": { # Suggestion generated using a Generator. # Suggestion details. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -136,14 +204,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. diff --git a/docs/dyn/dialogflow_v2.projects.locations.generators.evaluations.html b/docs/dyn/dialogflow_v2.projects.locations.generators.evaluations.html index fa924ca31b..2a3ca3d2b5 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.generators.evaluations.html +++ b/docs/dyn/dialogflow_v2.projects.locations.generators.evaluations.html @@ -149,6 +149,29 @@

Method Details

}, }, "initialGenerator": { # LLM generator. # Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of prebuilt Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["1.2"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -162,6 +185,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of prebuilt Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -179,6 +206,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -194,14 +289,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -241,6 +341,8 @@

Method Details

"updateTime": "A String", # Output only. Update time of this generator. }, "name": "A String", # Output only. Identifier. The resource name of the evaluation. Format: `projects//locations//generators// evaluations/` + "satisfiesPzi": True or False, # Output only. A read only boolean field reflecting Zone Isolation status of the model. The field is an aggregated value of ZI status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status + "satisfiesPzs": True or False, # Output only. A read only boolean field reflecting Zone Separation status of the model. The field is an aggregated value of ZS status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status "summarizationMetrics": { # Evaluation metrics for summarization generator. # Output only. Only available when the summarization generator is provided. "conversationDetails": [ # Output only. List of conversation details. { # Aggregated evaluation result on conversation level. This conatins evaluation results of all the metrics and sections. @@ -456,6 +558,29 @@

Method Details

}, }, "initialGenerator": { # LLM generator. # Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of prebuilt Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["1.2"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -469,6 +594,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of prebuilt Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -486,6 +615,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -501,14 +698,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -548,6 +750,8 @@

Method Details

"updateTime": "A String", # Output only. Update time of this generator. }, "name": "A String", # Output only. Identifier. The resource name of the evaluation. Format: `projects//locations//generators// evaluations/` + "satisfiesPzi": True or False, # Output only. A read only boolean field reflecting Zone Isolation status of the model. The field is an aggregated value of ZI status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status + "satisfiesPzs": True or False, # Output only. A read only boolean field reflecting Zone Separation status of the model. The field is an aggregated value of ZS status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status "summarizationMetrics": { # Evaluation metrics for summarization generator. # Output only. Only available when the summarization generator is provided. "conversationDetails": [ # Output only. List of conversation details. { # Aggregated evaluation result on conversation level. This conatins evaluation results of all the metrics and sections. @@ -721,6 +925,29 @@

Method Details

}, }, "initialGenerator": { # LLM generator. # Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of prebuilt Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["1.2"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -734,6 +961,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of prebuilt Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -751,6 +982,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -766,14 +1065,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -813,6 +1117,8 @@

Method Details

"updateTime": "A String", # Output only. Update time of this generator. }, "name": "A String", # Output only. Identifier. The resource name of the evaluation. Format: `projects//locations//generators// evaluations/` + "satisfiesPzi": True or False, # Output only. A read only boolean field reflecting Zone Isolation status of the model. The field is an aggregated value of ZI status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status + "satisfiesPzs": True or False, # Output only. A read only boolean field reflecting Zone Separation status of the model. The field is an aggregated value of ZS status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status "summarizationMetrics": { # Evaluation metrics for summarization generator. # Output only. Only available when the summarization generator is provided. "conversationDetails": [ # Output only. List of conversation details. { # Aggregated evaluation result on conversation level. This conatins evaluation results of all the metrics and sections. diff --git a/docs/dyn/dialogflow_v2.projects.locations.generators.html b/docs/dyn/dialogflow_v2.projects.locations.generators.html index 0c7a870af3..4d20d2ec51 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.generators.html +++ b/docs/dyn/dialogflow_v2.projects.locations.generators.html @@ -116,6 +116,29 @@

Method Details

The object takes the form of: { # LLM generator. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of prebuilt Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["1.2"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -129,6 +152,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of prebuilt Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -146,6 +173,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -161,14 +256,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -218,6 +318,29 @@

Method Details

An object of the form: { # LLM generator. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of prebuilt Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["1.2"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -231,6 +354,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of prebuilt Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -248,6 +375,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -263,14 +458,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -344,6 +544,29 @@

Method Details

An object of the form: { # LLM generator. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of prebuilt Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["1.2"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -357,6 +580,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of prebuilt Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -374,6 +601,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -389,14 +684,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -456,6 +756,29 @@

Method Details

{ # Response of ListGenerators. "generators": [ # List of generators retrieved. { # LLM generator. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of prebuilt Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["1.2"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -469,6 +792,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of prebuilt Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -486,6 +813,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -501,14 +896,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -576,6 +976,29 @@

Method Details

The object takes the form of: { # LLM generator. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of prebuilt Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["1.2"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -589,6 +1012,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of prebuilt Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -606,6 +1033,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -621,14 +1116,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -678,6 +1178,29 @@

Method Details

An object of the form: { # LLM generator. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of prebuilt Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["1.2"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -691,6 +1214,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of prebuilt Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -708,6 +1235,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -723,14 +1318,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. diff --git a/docs/dyn/dialogflow_v2.projects.locations.operations.html b/docs/dyn/dialogflow_v2.projects.locations.operations.html index bc806f58f7..2fdf143439 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.operations.html +++ b/docs/dyn/dialogflow_v2.projects.locations.operations.html @@ -84,7 +84,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -149,7 +149,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -157,6 +157,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -188,6 +189,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/dialogflow_v2.projects.locations.statelessSuggestion.html b/docs/dyn/dialogflow_v2.projects.locations.statelessSuggestion.html index 1fca89ff39..ac2f5322e7 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.statelessSuggestion.html +++ b/docs/dyn/dialogflow_v2.projects.locations.statelessSuggestion.html @@ -100,6 +100,7 @@

Method Details

"a_key": { # Represents a section of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -121,6 +122,29 @@

Method Details

], }, "generator": { # LLM generator. # Uncreated generator. It should be a complete generator that includes all information about the generator. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of prebuilt Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["1.2"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -134,6 +158,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of prebuilt Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -151,6 +179,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -166,14 +262,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -229,6 +330,74 @@

Method Details

{ # The response message for Conversations.GenerateStatelessSuggestion. "generatorSuggestion": { # Suggestion generated using a Generator. # Required. Generated suggestion for a conversation. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -244,14 +413,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call. "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. diff --git a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html index d3293e05e3..600553b927 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html @@ -109,6 +109,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -123,6 +124,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -154,6 +156,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -167,9 +177,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -184,6 +197,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -215,6 +229,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -228,6 +250,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. diff --git a/docs/dyn/dialogflow_v2.projects.operations.html b/docs/dyn/dialogflow_v2.projects.operations.html index bf79df4a80..260271a6bd 100644 --- a/docs/dyn/dialogflow_v2.projects.operations.html +++ b/docs/dyn/dialogflow_v2.projects.operations.html @@ -84,7 +84,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -149,7 +149,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -157,6 +157,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -188,6 +189,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/dialogflow_v2.projects.suggestions.html b/docs/dyn/dialogflow_v2.projects.suggestions.html index f221770f93..6283f60659 100644 --- a/docs/dyn/dialogflow_v2.projects.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.suggestions.html @@ -109,6 +109,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -123,6 +124,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -154,6 +156,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -167,9 +177,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -184,6 +197,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -215,6 +229,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -228,6 +250,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. diff --git a/docs/dyn/dialogflow_v2beta1.projects.answerRecords.html b/docs/dyn/dialogflow_v2beta1.projects.answerRecords.html index 23e33a78d5..b735e35b6a 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.answerRecords.html +++ b/docs/dyn/dialogflow_v2beta1.projects.answerRecords.html @@ -809,6 +809,74 @@

Method Details

"source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. }, "generatorSuggestion": { # Suggestion generated using a Generator. # Output only. The generator suggestion. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -824,14 +892,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -1599,6 +1672,74 @@

Method Details

"source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. }, "generatorSuggestion": { # Suggestion generated using a Generator. # Output only. The generator suggestion. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -1614,14 +1755,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -2396,6 +2542,74 @@

Method Details

"source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. }, "generatorSuggestion": { # Suggestion generated using a Generator. # Output only. The generator suggestion. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -2411,14 +2625,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -3175,6 +3394,74 @@

Method Details

"source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. }, "generatorSuggestion": { # Suggestion generated using a Generator. # Output only. The generator suggestion. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -3190,14 +3477,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html index c131c2a774..058e085444 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html @@ -169,6 +169,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -183,6 +184,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -214,6 +216,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -227,9 +237,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -244,6 +257,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -275,6 +289,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -288,6 +310,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -380,6 +404,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -394,6 +419,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -425,6 +451,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -438,9 +472,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -455,6 +492,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -486,6 +524,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -499,6 +545,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -616,6 +664,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -630,6 +679,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -661,6 +711,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -674,9 +732,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -691,6 +752,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -722,6 +784,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -735,6 +805,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -838,6 +910,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -852,6 +925,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -883,6 +957,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -896,9 +978,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -913,6 +998,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -944,6 +1030,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -957,6 +1051,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -1068,6 +1164,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1082,6 +1179,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1113,6 +1211,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -1126,9 +1232,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1143,6 +1252,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1174,6 +1284,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -1187,6 +1305,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -1280,6 +1400,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1294,6 +1415,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1325,6 +1447,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -1338,9 +1468,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1355,6 +1488,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1386,6 +1520,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -1399,6 +1541,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -1498,6 +1642,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1529,6 +1674,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.html index c81cee1e61..00121d18f5 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.html @@ -141,6 +141,7 @@

Method Details

"a_key": { # Represents a piece of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -194,6 +195,7 @@

Method Details

"a_key": { # Represents a piece of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -246,6 +248,7 @@

Method Details

"a_key": { # Represents a piece of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -304,6 +307,7 @@

Method Details

"a_key": { # Represents a piece of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -367,6 +371,7 @@

Method Details

"a_key": { # Represents a piece of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html index 61e6cf36a1..62a8bb95ae 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html @@ -240,15 +240,17 @@

Method Details

}, }, "requestId": "A String", # A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided. - "suggestionInput": { # Represents the selection of a suggestion. # An input representing the selection of a suggestion. - "answerRecord": "A String", # Required. The ID of a suggestion selected by the human agent. The suggestion(s) were generated in a previous call to request Dialogflow assist. The format is: `projects//locations//answerRecords/` where is an alphanumeric string. + "suggestionInput": { # Represents the action to take for a tool call that requires confirmation. # An input representing the selection of a suggestion. + "action": "A String", # Optional. The type of action to take with the tool. + "answerRecord": "A String", # Required. Format: `projects//locations//answerRecords/` The answer record associated with the tool call. "intentInput": { # Represents the intent to trigger programmatically rather than as a result of natural language processing. The intent input is only used for V3 agent. # The intent to be triggered on V3 agent. "intent": "A String", # Required. The unique identifier of the intent in V3 agent. Format: `projects//locations//locations//agents//intents/`. "languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. }, - "parameters": { # In Dialogflow assist for v3, the user can submit a form by sending a SuggestionInput. The form is uniquely determined by the answer_record field, which identifies a v3 QueryResult containing the current page. The form parameters are specified via the parameters field. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. + "parameters": { # Parameters to be used for the tool call. If not provided, the tool will be called without any parameters. "a_key": "", # Properties of the object. }, + "sendTime": "A String", # Optional. Time when the current suggest input is sent. For tool calls, this timestamp (along with the answer record) will be included in the corresponding tool call result so that it can be identified. "textOverride": { # Represents the natural language text to be processed. # Optional. If the customer edited the suggestion before using it, include the revised text here. "languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters for virtual agent interactions. @@ -1709,6 +1711,74 @@

Method Details

{ # A GeneratorSuggestion answer. "answerRecord": "A String", # Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback. "generatorSuggestion": { # Suggestion generated using a Generator. # Suggestion details. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -1724,14 +1794,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -3202,6 +3277,74 @@

Method Details

{ # A GeneratorSuggestion answer. "answerRecord": "A String", # Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback. "generatorSuggestion": { # Suggestion generated using a Generator. # Suggestion details. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -3217,14 +3360,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.suggestions.html index bc1e5c1e6a..428d714c2d 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.suggestions.html @@ -121,6 +121,74 @@

Method Details

{ # A GeneratorSuggestion answer. "answerRecord": "A String", # Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback. "generatorSuggestion": { # Suggestion generated using a Generator. # Suggestion details. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -136,14 +204,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. diff --git a/docs/dyn/dialogflow_v2beta1.projects.generators.html b/docs/dyn/dialogflow_v2beta1.projects.generators.html index f5277aa0a1..4bc89e839a 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.generators.html +++ b/docs/dyn/dialogflow_v2beta1.projects.generators.html @@ -102,6 +102,29 @@

Method Details

The object takes the form of: { # LLM generator. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["2.5"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -115,6 +138,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -132,6 +159,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -147,14 +242,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -204,6 +304,29 @@

Method Details

An object of the form: { # LLM generator. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["2.5"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -217,6 +340,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -234,6 +361,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -249,14 +444,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -316,6 +516,29 @@

Method Details

{ # Response of ListGenerators. "generators": [ # List of generators retrieved. { # LLM generator. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["2.5"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -329,6 +552,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -346,6 +573,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -361,14 +656,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.answerRecords.html b/docs/dyn/dialogflow_v2beta1.projects.locations.answerRecords.html index c8e398ec8b..7706453dda 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.answerRecords.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.answerRecords.html @@ -809,6 +809,74 @@

Method Details

"source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. }, "generatorSuggestion": { # Suggestion generated using a Generator. # Output only. The generator suggestion. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -824,14 +892,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -1599,6 +1672,74 @@

Method Details

"source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. }, "generatorSuggestion": { # Suggestion generated using a Generator. # Output only. The generator suggestion. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -1614,14 +1755,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -2396,6 +2542,74 @@

Method Details

"source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. }, "generatorSuggestion": { # Suggestion generated using a Generator. # Output only. The generator suggestion. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -2411,14 +2625,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -3175,6 +3394,74 @@

Method Details

"source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. }, "generatorSuggestion": { # Suggestion generated using a Generator. # Output only. The generator suggestion. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -3190,14 +3477,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html index d15e2b6283..0ee5bf0256 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html @@ -169,6 +169,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -183,6 +184,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -214,6 +216,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -227,9 +237,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -244,6 +257,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -275,6 +289,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -288,6 +310,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -380,6 +404,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -394,6 +419,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -425,6 +451,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -438,9 +472,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -455,6 +492,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -486,6 +524,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -499,6 +545,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -616,6 +664,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -630,6 +679,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -661,6 +711,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -674,9 +732,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -691,6 +752,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -722,6 +784,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -735,6 +805,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -838,6 +910,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -852,6 +925,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -883,6 +957,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -896,9 +978,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -913,6 +998,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -944,6 +1030,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -957,6 +1051,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -1068,6 +1164,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1082,6 +1179,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1113,6 +1211,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -1126,9 +1232,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1143,6 +1252,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1174,6 +1284,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -1187,6 +1305,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -1280,6 +1400,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1294,6 +1415,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1325,6 +1447,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -1338,9 +1468,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1355,6 +1488,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1386,6 +1520,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -1399,6 +1541,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. @@ -1498,6 +1642,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1529,6 +1674,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html index 000e77a831..eae70edef0 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html @@ -144,6 +144,7 @@

Method Details

"a_key": { # Represents a piece of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -197,6 +198,7 @@

Method Details

"a_key": { # Represents a piece of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -249,6 +251,7 @@

Method Details

"a_key": { # Represents a piece of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -307,6 +310,7 @@

Method Details

"a_key": { # Represents a piece of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -357,6 +361,7 @@

Method Details

"a_key": { # Represents a piece of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -382,6 +387,7 @@

Method Details

"a_key": { # Represents a piece of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -422,6 +428,7 @@

Method Details

"a_key": { # Represents a piece of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html index 8640d98533..7a7b411200 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html @@ -240,15 +240,17 @@

Method Details

}, }, "requestId": "A String", # A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided. - "suggestionInput": { # Represents the selection of a suggestion. # An input representing the selection of a suggestion. - "answerRecord": "A String", # Required. The ID of a suggestion selected by the human agent. The suggestion(s) were generated in a previous call to request Dialogflow assist. The format is: `projects//locations//answerRecords/` where is an alphanumeric string. + "suggestionInput": { # Represents the action to take for a tool call that requires confirmation. # An input representing the selection of a suggestion. + "action": "A String", # Optional. The type of action to take with the tool. + "answerRecord": "A String", # Required. Format: `projects//locations//answerRecords/` The answer record associated with the tool call. "intentInput": { # Represents the intent to trigger programmatically rather than as a result of natural language processing. The intent input is only used for V3 agent. # The intent to be triggered on V3 agent. "intent": "A String", # Required. The unique identifier of the intent in V3 agent. Format: `projects//locations//locations//agents//intents/`. "languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. }, - "parameters": { # In Dialogflow assist for v3, the user can submit a form by sending a SuggestionInput. The form is uniquely determined by the answer_record field, which identifies a v3 QueryResult containing the current page. The form parameters are specified via the parameters field. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. + "parameters": { # Parameters to be used for the tool call. If not provided, the tool will be called without any parameters. "a_key": "", # Properties of the object. }, + "sendTime": "A String", # Optional. Time when the current suggest input is sent. For tool calls, this timestamp (along with the answer record) will be included in the corresponding tool call result so that it can be identified. "textOverride": { # Represents the natural language text to be processed. # Optional. If the customer edited the suggestion before using it, include the revised text here. "languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters for virtual agent interactions. @@ -1709,6 +1711,74 @@

Method Details

{ # A GeneratorSuggestion answer. "answerRecord": "A String", # Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback. "generatorSuggestion": { # Suggestion generated using a Generator. # Suggestion details. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -1724,14 +1794,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -3202,6 +3277,74 @@

Method Details

{ # A GeneratorSuggestion answer. "answerRecord": "A String", # Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback. "generatorSuggestion": { # Suggestion generated using a Generator. # Suggestion details. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -3217,14 +3360,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.suggestions.html index a56319719e..533eba141f 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.suggestions.html @@ -121,6 +121,74 @@

Method Details

{ # A GeneratorSuggestion answer. "answerRecord": "A String", # Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback. "generatorSuggestion": { # Suggestion generated using a Generator. # Suggestion details. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -136,14 +204,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.generators.evaluations.html b/docs/dyn/dialogflow_v2beta1.projects.locations.generators.evaluations.html index d63d10cdb1..4ce7ae18ec 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.generators.evaluations.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.generators.evaluations.html @@ -149,6 +149,29 @@

Method Details

}, }, "initialGenerator": { # LLM generator. # Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["2.5"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -162,6 +185,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -179,6 +206,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -194,14 +289,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -241,6 +341,8 @@

Method Details

"updateTime": "A String", # Output only. Update time of this generator. }, "name": "A String", # Output only. Identifier. The resource name of the evaluation. Format: `projects//locations//generators// evaluations/` + "satisfiesPzi": True or False, # Output only. A read only boolean field reflecting Zone Isolation status of the model. The field is an aggregated value of ZI status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status + "satisfiesPzs": True or False, # Output only. A read only boolean field reflecting Zone Separation status of the model. The field is an aggregated value of ZS status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status "summarizationMetrics": { # Evaluation metrics for summarization generator. # Output only. Only available when the summarization generator is provided. "conversationDetails": [ # Output only. List of conversation details. { # Aggregated evaluation result on conversation level. This contains evaluation results of all the metrics and sections. @@ -456,6 +558,29 @@

Method Details

}, }, "initialGenerator": { # LLM generator. # Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["2.5"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -469,6 +594,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -486,6 +615,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -501,14 +698,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -548,6 +750,8 @@

Method Details

"updateTime": "A String", # Output only. Update time of this generator. }, "name": "A String", # Output only. Identifier. The resource name of the evaluation. Format: `projects//locations//generators// evaluations/` + "satisfiesPzi": True or False, # Output only. A read only boolean field reflecting Zone Isolation status of the model. The field is an aggregated value of ZI status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status + "satisfiesPzs": True or False, # Output only. A read only boolean field reflecting Zone Separation status of the model. The field is an aggregated value of ZS status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status "summarizationMetrics": { # Evaluation metrics for summarization generator. # Output only. Only available when the summarization generator is provided. "conversationDetails": [ # Output only. List of conversation details. { # Aggregated evaluation result on conversation level. This contains evaluation results of all the metrics and sections. @@ -721,6 +925,29 @@

Method Details

}, }, "initialGenerator": { # LLM generator. # Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["2.5"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -734,6 +961,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -751,6 +982,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -766,14 +1065,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -813,6 +1117,8 @@

Method Details

"updateTime": "A String", # Output only. Update time of this generator. }, "name": "A String", # Output only. Identifier. The resource name of the evaluation. Format: `projects//locations//generators// evaluations/` + "satisfiesPzi": True or False, # Output only. A read only boolean field reflecting Zone Isolation status of the model. The field is an aggregated value of ZI status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status + "satisfiesPzs": True or False, # Output only. A read only boolean field reflecting Zone Separation status of the model. The field is an aggregated value of ZS status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status "summarizationMetrics": { # Evaluation metrics for summarization generator. # Output only. Only available when the summarization generator is provided. "conversationDetails": [ # Output only. List of conversation details. { # Aggregated evaluation result on conversation level. This contains evaluation results of all the metrics and sections. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.generators.html b/docs/dyn/dialogflow_v2beta1.projects.locations.generators.html index fbde9d3966..fc1db28037 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.generators.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.generators.html @@ -116,6 +116,29 @@

Method Details

The object takes the form of: { # LLM generator. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["2.5"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -129,6 +152,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -146,6 +173,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -161,14 +256,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -218,6 +318,29 @@

Method Details

An object of the form: { # LLM generator. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["2.5"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -231,6 +354,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -248,6 +375,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -263,14 +458,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -344,6 +544,29 @@

Method Details

An object of the form: { # LLM generator. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["2.5"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -357,6 +580,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -374,6 +601,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -389,14 +684,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -456,6 +756,29 @@

Method Details

{ # Response of ListGenerators. "generators": [ # List of generators retrieved. { # LLM generator. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["2.5"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -469,6 +792,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -486,6 +813,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -501,14 +896,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -576,6 +976,29 @@

Method Details

The object takes the form of: { # LLM generator. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["2.5"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -589,6 +1012,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -606,6 +1033,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -621,14 +1116,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -678,6 +1178,29 @@

Method Details

An object of the form: { # LLM generator. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["2.5"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -691,6 +1214,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -708,6 +1235,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -723,14 +1318,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.operations.html b/docs/dyn/dialogflow_v2beta1.projects.locations.operations.html index 0f9c3b1cca..987ef9a3e1 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.operations.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.operations.html @@ -84,7 +84,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -149,7 +149,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -157,6 +157,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -188,6 +189,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.statelessSuggestion.html b/docs/dyn/dialogflow_v2beta1.projects.locations.statelessSuggestion.html index e604d3bdd1..4a3d8572e3 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.statelessSuggestion.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.statelessSuggestion.html @@ -100,6 +100,7 @@

Method Details

"a_key": { # Represents a piece of ingested context information. "contextContents": [ # Required. The list of content updates for a context reference. { # Contents ingested. + "answerRecord": "A String", # If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`. "content": "A String", # Required. The information ingested in a single request. "contentFormat": "A String", # Required. The format of the ingested string. "ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference. @@ -121,6 +122,29 @@

Method Details

], }, "generator": { # LLM generator. # Uncreated generator. It should be a complete generator that includes all information about the generator. + "agentCoachingContext": { # Agent Coaching context that customer can configure. # Input of Agent Coaching feature. + "instructions": [ # Optional. Customized instructions for agent coaching. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "outputLanguageCode": "A String", # Optional. Output language code. + "overarchingGuidance": "A String", # Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions. + "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["2.5"]. + }, "createTime": "A String", # Output only. Creation time of this generator. "description": "A String", # Optional. Human readable description of the generator. "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM. @@ -134,6 +158,10 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + "suggestionDedupingConfig": { # Config for suggestion deduping. NEXT_ID: 3 # Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature. + "enableDeduping": True or False, # Optional. Whether to enable suggestion deduping. + "similarityThreshold": 3.14, # Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + }, "summarizationContext": { # Summarization context that customer can configure. # Input of Summarization feature. "fewShotExamples": [ # Optional. List of few shot examples. { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. @@ -151,6 +179,74 @@

Method Details

"a_key": "A String", }, "output": { # Suggestion generated using a Generator. # Required. Example output of the model. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -166,14 +262,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. @@ -229,6 +330,74 @@

Method Details

{ # The response message for Conversations.GenerateStatelessSuggestion. "generatorSuggestion": { # Suggestion generated using a Generator. # Required. Generated suggestion for a conversation. + "agentCoachingSuggestion": { # Suggestion for coaching agents. # Optional. Suggestion to coach the agent. + "agentActionSuggestions": [ # Optional. Suggested actions for the agent to take. + { # Actions suggested for the agent. This is based on applicable instructions. + "agentAction": "A String", # Optional. The suggested action for the agent. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the agent action suggestion. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "sources": { # Sources for the suggestion. # Output only. Sources for the agent action suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + "applicableInstructions": [ # Optional. Instructions applicable based on the current context. + { # Agent Coaching instructions that customer can configure. + "agentAction": "A String", # Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty + "condition": "A String", # Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. + "displayDetails": "A String", # Optional. The detailed description of this instruction. + "displayName": "A String", # Optional. Display name for the instruction. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplication check for the AgentCoachingInstruction. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "systemAction": "A String", # Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty + }, + ], + "sampleResponses": [ # Optional. Sample response for the Agent. + { # Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. + "duplicateCheckResult": { # Duplication check for the suggestion. # Output only. Duplicate check result for the sample response. + "duplicateSuggestions": [ # Output only. The duplicate suggestions. + { # The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions. + "answerRecord": "A String", # Output only. The answer record id of the past duplicate suggestion. + "similarityScore": 3.14, # Output only. The similarity score of between the past and current suggestion. + "sources": { # Sources for the suggestion. # Output only. Sources for the suggestion. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + "suggestionIndex": 42, # Output only. The index of the duplicate suggestion in the past suggestion list. + }, + ], + }, + "responseText": "A String", # Optional. Sample response for Agent in text. + "sources": { # Sources for the suggestion. # Output only. Sources for the Sample Response. + "instructionIndexes": [ # Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field. + 42, + ], + }, + }, + ], + }, "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion. "response": "A String", # Required. Free form suggestion. }, @@ -244,14 +413,19 @@

Method Details

{ # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "state": "A String", # Output only. State of the tool call "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. + "toolDisplayDetails": "A String", # Optional. A human readable description of the tool. + "toolDisplayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. "action": "A String", # Optional. The name of the tool's action associated with this call. + "answerRecord": "A String", # Optional. The answer record associated with this tool call result. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html index 9ea0fce4b7..e88d4a6f87 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html @@ -109,6 +109,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -123,6 +124,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -154,6 +156,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -167,9 +177,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -184,6 +197,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -215,6 +229,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -228,6 +250,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. diff --git a/docs/dyn/dialogflow_v2beta1.projects.operations.html b/docs/dyn/dialogflow_v2beta1.projects.operations.html index 1e2abd3d29..29d1bb0975 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.operations.html +++ b/docs/dyn/dialogflow_v2beta1.projects.operations.html @@ -84,7 +84,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -149,7 +149,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -157,6 +157,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -188,6 +189,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html index 3599f88dd2..d779c8ed5b 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html @@ -109,6 +109,7 @@

Method Details

"humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -123,6 +124,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -154,6 +156,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -167,9 +177,12 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST + "enableAsyncToolCall": True or False, # Optional. If true, enable asynchronous execution of tools. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -184,6 +197,7 @@

Method Details

"enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST + "enableResponseDebugInfo": True or False, # Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -215,6 +229,14 @@

Method Details

], }, }, + "raiSettings": { # Settings for Responsible AI checks. # Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST + "raiCategoryConfigs": [ # Configuration for a set of RAI categories. + { # Configuration for a specific RAI category. + "category": "A String", # Optional. The RAI category. + "sensitivityLevel": "A String", # Optional. The sensitivity level for this category. + }, + ], + }, "suggestionFeature": { # The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. # The suggestion feature. "type": "A String", # Type of Human Agent Assistant API feature to request. }, @@ -228,6 +250,8 @@

Method Details

"A String", ], "groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. + "skipEmptyEventBasedSuggestion": True or False, # Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. + "useUnredactedConversationData": True or False, # Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) }, "messageAnalysisConfig": { # Configuration for analyses to run on each conversation message. # Configuration for message analysis. "enableEntityExtraction": True or False, # Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. diff --git a/docs/dyn/dialogflow_v3.projects.locations.operations.html b/docs/dyn/dialogflow_v3.projects.locations.operations.html index ccff492925..899537cc85 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.operations.html +++ b/docs/dyn/dialogflow_v3.projects.locations.operations.html @@ -84,7 +84,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -149,7 +149,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -157,6 +157,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -188,6 +189,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/dialogflow_v3.projects.operations.html b/docs/dyn/dialogflow_v3.projects.operations.html index 44b6a7e8f1..d7b6f32876 100644 --- a/docs/dyn/dialogflow_v3.projects.operations.html +++ b/docs/dyn/dialogflow_v3.projects.operations.html @@ -84,7 +84,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -149,7 +149,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -157,6 +157,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -188,6 +189,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.operations.html b/docs/dyn/dialogflow_v3beta1.projects.locations.operations.html index 0c7f9c86f4..0fb9a90a8b 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.operations.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.operations.html @@ -84,7 +84,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -149,7 +149,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -157,6 +157,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -188,6 +189,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/dialogflow_v3beta1.projects.operations.html b/docs/dyn/dialogflow_v3beta1.projects.operations.html index 9e0465f5e6..6e2e251387 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.operations.html +++ b/docs/dyn/dialogflow_v3beta1.projects.operations.html @@ -84,7 +84,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -149,7 +149,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -157,6 +157,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -188,6 +189,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html index e9829bdedc..f9d3315a38 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html @@ -248,7 +248,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -459,7 +459,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -626,7 +626,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -781,7 +781,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -918,7 +918,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. 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 52d2e6aefa..4710bf0417 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html @@ -563,6 +563,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -2283,6 +2366,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html index 9b5afb6fe4..6cd6aa32ca 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html @@ -261,6 +261,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -427,6 +510,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -619,6 +785,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -799,6 +1048,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -983,6 +1315,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -1150,6 +1565,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html index 86333e9caa..155c775b01 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html @@ -163,14 +163,14 @@

Method Details

"commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine. "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at. "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. "A String", ], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -299,14 +299,14 @@

Method Details

"commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine. "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at. "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. "A String", ], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -376,14 +376,14 @@

Method Details

"commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine. "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at. "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. "A String", ], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -460,14 +460,14 @@

Method Details

"commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine. "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at. "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. "A String", ], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -526,14 +526,14 @@

Method Details

"commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine. "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at. "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. "A String", ], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. 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 a7dc9b7b7d..fe89d51dbd 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html @@ -563,6 +563,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -2283,6 +2366,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html index 5341928187..87450e75d4 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html @@ -261,6 +261,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -427,6 +510,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -619,6 +785,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -799,6 +1048,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -983,6 +1315,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -1150,6 +1565,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html index da13e93ed2..20c1569318 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html @@ -240,7 +240,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -451,7 +451,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -618,7 +618,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -773,7 +773,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -910,7 +910,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html index 0e544cdd42..feb234373f 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html @@ -563,6 +563,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -2283,6 +2366,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html index 35f47adda8..cbe97afd56 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html @@ -261,6 +261,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -427,6 +510,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -619,6 +785,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -799,6 +1048,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -983,6 +1315,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -1150,6 +1565,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.html b/docs/dyn/discoveryengine_v1.projects.locations.html index 830be40752..fda89b33b3 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.html @@ -99,6 +99,11 @@

Instance Methods

Returns the identityMappingStores Resource.

+

+ licenseConfigs() +

+

Returns the licenseConfigs Resource.

+

operations()

diff --git a/docs/dyn/discoveryengine_v1.projects.locations.licenseConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.licenseConfigs.html new file mode 100644 index 0000000000..4f56c0ca34 --- /dev/null +++ b/docs/dyn/discoveryengine_v1.projects.locations.licenseConfigs.html @@ -0,0 +1,338 @@ + + + +

Discovery Engine API . projects . locations . licenseConfigs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a LicenseConfig

+

+ get(name, x__xgafv=None)

+

Gets a LicenseConfig.

+

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

+

Updates the LicenseConfig

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, licenseConfigId=None, x__xgafv=None) +
Creates a LicenseConfig
+
+Args:
+  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Information about users' licenses.
+  "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
+    "alertEnrollments": [ # Optional. The enrollment state of each alert.
+      { # The alert enrollment status.
+        "alertId": "A String", # Immutable. The id of an alert.
+        "enrollState": "A String", # Required. The enrollment status of a customer.
+        "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
+          "a_key": "A String",
+        },
+      },
+    ],
+    "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+    "contactDetails": [ # Optional. The contact details for each alert policy.
+      { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
+        "emailAddress": "A String", # Optional. The email address of the contact.
+      },
+    ],
+    "languageCode": "A String", # Optional. The language code used for notifications
+  },
+  "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+  "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "freeTrial": True or False, # Optional. Whether the license config is for free trial.
+  "licenseCount": "A String", # Required. Number of licenses purchased.
+  "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
+  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "state": "A String", # Output only. The state of the license config.
+  "subscriptionTerm": "A String", # Required. Subscription term.
+  "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
+}
+
+  licenseConfigId: string, Optional. The ID to use for the LicenseConfig, which will become the final component of the LicenseConfig's resource name. We are using the tier (product edition) name as the license config id such as `search` or `search_and_assistant`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Information about users' licenses.
+  "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
+    "alertEnrollments": [ # Optional. The enrollment state of each alert.
+      { # The alert enrollment status.
+        "alertId": "A String", # Immutable. The id of an alert.
+        "enrollState": "A String", # Required. The enrollment status of a customer.
+        "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
+          "a_key": "A String",
+        },
+      },
+    ],
+    "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+    "contactDetails": [ # Optional. The contact details for each alert policy.
+      { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
+        "emailAddress": "A String", # Optional. The email address of the contact.
+      },
+    ],
+    "languageCode": "A String", # Optional. The language code used for notifications
+  },
+  "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+  "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "freeTrial": True or False, # Optional. Whether the license config is for free trial.
+  "licenseCount": "A String", # Required. Number of licenses purchased.
+  "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
+  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "state": "A String", # Output only. The state of the license config.
+  "subscriptionTerm": "A String", # Required. Subscription term.
+  "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a LicenseConfig.
+
+Args:
+  name: string, Required. Full resource name of LicenseConfig, such as `projects/{project}/locations/{location}/licenseConfigs/*`. If the caller does not have permission to access the LicenseConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested LicenseConfig does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Information about users' licenses.
+  "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
+    "alertEnrollments": [ # Optional. The enrollment state of each alert.
+      { # The alert enrollment status.
+        "alertId": "A String", # Immutable. The id of an alert.
+        "enrollState": "A String", # Required. The enrollment status of a customer.
+        "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
+          "a_key": "A String",
+        },
+      },
+    ],
+    "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+    "contactDetails": [ # Optional. The contact details for each alert policy.
+      { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
+        "emailAddress": "A String", # Optional. The email address of the contact.
+      },
+    ],
+    "languageCode": "A String", # Optional. The language code used for notifications
+  },
+  "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+  "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "freeTrial": True or False, # Optional. Whether the license config is for free trial.
+  "licenseCount": "A String", # Required. Number of licenses purchased.
+  "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
+  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "state": "A String", # Output only. The state of the license config.
+  "subscriptionTerm": "A String", # Required. Subscription term.
+  "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
+}
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the LicenseConfig
+
+Args:
+  name: string, Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Information about users' licenses.
+  "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
+    "alertEnrollments": [ # Optional. The enrollment state of each alert.
+      { # The alert enrollment status.
+        "alertId": "A String", # Immutable. The id of an alert.
+        "enrollState": "A String", # Required. The enrollment status of a customer.
+        "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
+          "a_key": "A String",
+        },
+      },
+    ],
+    "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+    "contactDetails": [ # Optional. The contact details for each alert policy.
+      { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
+        "emailAddress": "A String", # Optional. The email address of the contact.
+      },
+    ],
+    "languageCode": "A String", # Optional. The language code used for notifications
+  },
+  "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+  "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "freeTrial": True or False, # Optional. Whether the license config is for free trial.
+  "licenseCount": "A String", # Required. Number of licenses purchased.
+  "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
+  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "state": "A String", # Output only. The state of the license config.
+  "subscriptionTerm": "A String", # Required. Subscription term.
+  "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
+}
+
+  updateMask: string, Optional. Indicates which fields in the provided LicenseConfig to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Information about users' licenses.
+  "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
+    "alertEnrollments": [ # Optional. The enrollment state of each alert.
+      { # The alert enrollment status.
+        "alertId": "A String", # Immutable. The id of an alert.
+        "enrollState": "A String", # Required. The enrollment status of a customer.
+        "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
+          "a_key": "A String",
+        },
+      },
+    ],
+    "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+    "contactDetails": [ # Optional. The contact details for each alert policy.
+      { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
+        "emailAddress": "A String", # Optional. The email address of the contact.
+      },
+    ],
+    "languageCode": "A String", # Optional. The language code used for notifications
+  },
+  "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+  "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "freeTrial": True or False, # Optional. Whether the license config is for free trial.
+  "licenseCount": "A String", # Required. Number of licenses purchased.
+  "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
+  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "state": "A String", # Output only. The state of the license config.
+  "subscriptionTerm": "A String", # Required. Subscription term.
+  "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html index 3181d3d3af..aab0dbbff7 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html @@ -259,7 +259,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -505,7 +505,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -788,7 +788,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -978,7 +978,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -1150,7 +1150,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. 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 8c9c479037..155f4b8005 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html @@ -618,6 +618,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -3143,6 +3227,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html index 3071561c6e..49f3c8a168 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html @@ -276,6 +276,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -457,6 +541,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -664,6 +832,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -859,6 +1111,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -1058,6 +1394,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -1240,6 +1660,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html index 8206d9f04e..4b6e3174d7 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html @@ -291,7 +291,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html index 8e76c3a18e..6c534fbed5 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html @@ -182,14 +182,14 @@

Method Details

"commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine. "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at. "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. "A String", ], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -327,14 +327,14 @@

Method Details

"commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine. "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at. "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. "A String", ], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -413,14 +413,14 @@

Method Details

"commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine. "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at. "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. "A String", ], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -506,14 +506,14 @@

Method Details

"commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine. "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at. "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. "A String", ], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -581,14 +581,14 @@

Method Details

"commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine. "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at. "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. "A String", ], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -668,14 +668,14 @@

Method Details

"commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine. "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at. "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. "A String", ], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -755,14 +755,14 @@

Method Details

"commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine. "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at. "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. "A String", ], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. 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 cdeb0c09f6..0688195cdb 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html @@ -618,6 +618,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -3143,6 +3227,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html index bfe3ed8232..b217d84f71 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html @@ -281,6 +281,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -462,6 +546,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -669,6 +837,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -864,6 +1116,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -1063,6 +1399,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -1245,6 +1665,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html index af65130f91..5fc2094251 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html @@ -291,7 +291,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html index 4686192f88..ece123a8cb 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html @@ -251,7 +251,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -497,7 +497,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -780,7 +780,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -970,7 +970,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -1142,7 +1142,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html index 27e8864b00..7a68c3a6eb 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html @@ -618,6 +618,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -3143,6 +3227,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html index cb642ceeaa..8a3ac91647 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html @@ -276,6 +276,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -457,6 +541,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -664,6 +832,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -859,6 +1111,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -1058,6 +1394,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -1240,6 +1660,90 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html index b39ec57857..e539f634e0 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html @@ -291,7 +291,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html index 076f808cd4..fb9c7384f8 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html @@ -104,6 +104,11 @@

Instance Methods

Returns the identityMappingStores Resource.

+

+ licenseConfigs() +

+

Returns the licenseConfigs Resource.

+

notebooks()

diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.licenseConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.licenseConfigs.html new file mode 100644 index 0000000000..bba1c4f611 --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.licenseConfigs.html @@ -0,0 +1,338 @@ + + + +

Discovery Engine API . projects . locations . licenseConfigs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a LicenseConfig

+

+ get(name, x__xgafv=None)

+

Gets a LicenseConfig.

+

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

+

Updates the LicenseConfig

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, licenseConfigId=None, x__xgafv=None) +
Creates a LicenseConfig
+
+Args:
+  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Information about users' licenses.
+  "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
+    "alertEnrollments": [ # Optional. The enrollment state of each alert.
+      { # The alert enrollment status.
+        "alertId": "A String", # Immutable. The id of an alert.
+        "enrollState": "A String", # Required. The enrollment status of a customer.
+        "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
+          "a_key": "A String",
+        },
+      },
+    ],
+    "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+    "contactDetails": [ # Optional. The contact details for each alert policy.
+      { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
+        "emailAddress": "A String", # Optional. The email address of the contact.
+      },
+    ],
+    "languageCode": "A String", # Optional. The language code used for notifications
+  },
+  "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+  "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "freeTrial": True or False, # Optional. Whether the license config is for free trial.
+  "licenseCount": "A String", # Required. Number of licenses purchased.
+  "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
+  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "state": "A String", # Output only. The state of the license config.
+  "subscriptionTerm": "A String", # Required. Subscription term.
+  "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
+}
+
+  licenseConfigId: string, Optional. The ID to use for the LicenseConfig, which will become the final component of the LicenseConfig's resource name. We are using the tier (product edition) name as the license config id such as `search` or `search_and_assistant`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Information about users' licenses.
+  "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
+    "alertEnrollments": [ # Optional. The enrollment state of each alert.
+      { # The alert enrollment status.
+        "alertId": "A String", # Immutable. The id of an alert.
+        "enrollState": "A String", # Required. The enrollment status of a customer.
+        "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
+          "a_key": "A String",
+        },
+      },
+    ],
+    "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+    "contactDetails": [ # Optional. The contact details for each alert policy.
+      { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
+        "emailAddress": "A String", # Optional. The email address of the contact.
+      },
+    ],
+    "languageCode": "A String", # Optional. The language code used for notifications
+  },
+  "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+  "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "freeTrial": True or False, # Optional. Whether the license config is for free trial.
+  "licenseCount": "A String", # Required. Number of licenses purchased.
+  "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
+  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "state": "A String", # Output only. The state of the license config.
+  "subscriptionTerm": "A String", # Required. Subscription term.
+  "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a LicenseConfig.
+
+Args:
+  name: string, Required. Full resource name of LicenseConfig, such as `projects/{project}/locations/{location}/licenseConfigs/*`. If the caller does not have permission to access the LicenseConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested LicenseConfig does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Information about users' licenses.
+  "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
+    "alertEnrollments": [ # Optional. The enrollment state of each alert.
+      { # The alert enrollment status.
+        "alertId": "A String", # Immutable. The id of an alert.
+        "enrollState": "A String", # Required. The enrollment status of a customer.
+        "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
+          "a_key": "A String",
+        },
+      },
+    ],
+    "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+    "contactDetails": [ # Optional. The contact details for each alert policy.
+      { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
+        "emailAddress": "A String", # Optional. The email address of the contact.
+      },
+    ],
+    "languageCode": "A String", # Optional. The language code used for notifications
+  },
+  "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+  "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "freeTrial": True or False, # Optional. Whether the license config is for free trial.
+  "licenseCount": "A String", # Required. Number of licenses purchased.
+  "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
+  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "state": "A String", # Output only. The state of the license config.
+  "subscriptionTerm": "A String", # Required. Subscription term.
+  "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
+}
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the LicenseConfig
+
+Args:
+  name: string, Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Information about users' licenses.
+  "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
+    "alertEnrollments": [ # Optional. The enrollment state of each alert.
+      { # The alert enrollment status.
+        "alertId": "A String", # Immutable. The id of an alert.
+        "enrollState": "A String", # Required. The enrollment status of a customer.
+        "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
+          "a_key": "A String",
+        },
+      },
+    ],
+    "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+    "contactDetails": [ # Optional. The contact details for each alert policy.
+      { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
+        "emailAddress": "A String", # Optional. The email address of the contact.
+      },
+    ],
+    "languageCode": "A String", # Optional. The language code used for notifications
+  },
+  "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+  "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "freeTrial": True or False, # Optional. Whether the license config is for free trial.
+  "licenseCount": "A String", # Required. Number of licenses purchased.
+  "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
+  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "state": "A String", # Output only. The state of the license config.
+  "subscriptionTerm": "A String", # Required. Subscription term.
+  "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
+}
+
+  updateMask: string, Optional. Indicates which fields in the provided LicenseConfig to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Information about users' licenses.
+  "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
+    "alertEnrollments": [ # Optional. The enrollment state of each alert.
+      { # The alert enrollment status.
+        "alertId": "A String", # Immutable. The id of an alert.
+        "enrollState": "A String", # Required. The enrollment status of a customer.
+        "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
+          "a_key": "A String",
+        },
+      },
+    ],
+    "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+    "contactDetails": [ # Optional. The contact details for each alert policy.
+      { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
+        "emailAddress": "A String", # Optional. The email address of the contact.
+      },
+    ],
+    "languageCode": "A String", # Optional. The language code used for notifications
+  },
+  "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+  "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "freeTrial": True or False, # Optional. Whether the license config is for free trial.
+  "licenseCount": "A String", # Required. Number of licenses purchased.
+  "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
+  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "state": "A String", # Output only. The state of the license config.
+  "subscriptionTerm": "A String", # Required. Subscription term.
+  "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html index 8f6f5ee818..bc7fcdb490 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html @@ -248,7 +248,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -468,7 +468,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -644,7 +644,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -808,7 +808,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -954,7 +954,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. 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 01b2f05fed..731e1df9d5 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -615,6 +615,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -3097,6 +3180,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html index 068375f9e0..81bae4f2fc 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html @@ -276,6 +276,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -457,6 +540,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -664,6 +830,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -859,6 +1108,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -1058,6 +1390,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -1240,6 +1655,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html index 8afa0d3f9a..46f7a9b8e9 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html @@ -172,14 +172,14 @@

Method Details

"commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine. "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at. "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. "A String", ], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -308,14 +308,14 @@

Method Details

"commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine. "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at. "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. "A String", ], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -385,14 +385,14 @@

Method Details

"commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine. "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at. "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. "A String", ], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -469,14 +469,14 @@

Method Details

"commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine. "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at. "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. "A String", ], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -535,14 +535,14 @@

Method Details

"commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine. "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at. "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. "A String", ], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -613,14 +613,14 @@

Method Details

"commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine. "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at. "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. "A String", ], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -691,14 +691,14 @@

Method Details

"commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine. "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at. "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. "A String", ], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. 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 059af78dda..2831ab131a 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -615,6 +615,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -3097,6 +3180,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html index ad92a0caa2..da45fdd215 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html @@ -276,6 +276,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -457,6 +540,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -664,6 +830,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -859,6 +1108,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -1058,6 +1390,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -1240,6 +1655,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html index 5b8a7f90cb..bc3018281d 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html @@ -240,7 +240,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -460,7 +460,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -636,7 +636,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -800,7 +800,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -946,7 +946,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, - "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index 041fafc956..74da1b678c 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -615,6 +615,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -3097,6 +3180,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html index 6bcbbac561..d2c7f01d07 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html @@ -276,6 +276,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -457,6 +540,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -664,6 +830,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -859,6 +1108,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -1058,6 +1390,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. @@ -1240,6 +1655,89 @@

Method Details

}, ], }, + "detailedAssistAnswer": { # AssistAnswer resource, main part of AssistResponse. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. + "policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. + { # Customer policy enforcement result for a single policy type. + "bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy. + "bannedPhrases": [ # The banned phrases that were found in the query or the answer. + "A String", + ], + }, + "modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy. + "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 returned by Model Armor if the policy enforcement failed for some reason. + "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. + }, + "modelArmorViolation": "A String", # The Model Armor violation that was found. + }, + }, + ], + "verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. + }, + "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.html index 9b2d68c51f..aeb721d9fb 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.html @@ -104,6 +104,11 @@

Instance Methods

Returns the identityMappingStores Resource.

+

+ licenseConfigs() +

+

Returns the licenseConfigs Resource.

+

operations()

diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.licenseConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.licenseConfigs.html new file mode 100644 index 0000000000..577c0eaca0 --- /dev/null +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.licenseConfigs.html @@ -0,0 +1,338 @@ + + + +

Discovery Engine API . projects . locations . licenseConfigs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a LicenseConfig

+

+ get(name, x__xgafv=None)

+

Gets a LicenseConfig.

+

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

+

Updates the LicenseConfig

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, licenseConfigId=None, x__xgafv=None) +
Creates a LicenseConfig
+
+Args:
+  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Information about users' licenses.
+  "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
+    "alertEnrollments": [ # Optional. The enrollment state of each alert.
+      { # The alert enrollment status.
+        "alertId": "A String", # Immutable. The id of an alert.
+        "enrollState": "A String", # Required. The enrollment status of a customer.
+        "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
+          "a_key": "A String",
+        },
+      },
+    ],
+    "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+    "contactDetails": [ # Optional. The contact details for each alert policy.
+      { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
+        "emailAddress": "A String", # Optional. The email address of the contact.
+      },
+    ],
+    "languageCode": "A String", # Optional. The language code used for notifications
+  },
+  "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+  "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "freeTrial": True or False, # Optional. Whether the license config is for free trial.
+  "licenseCount": "A String", # Required. Number of licenses purchased.
+  "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
+  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "state": "A String", # Output only. The state of the license config.
+  "subscriptionTerm": "A String", # Required. Subscription term.
+  "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
+}
+
+  licenseConfigId: string, Optional. The ID to use for the LicenseConfig, which will become the final component of the LicenseConfig's resource name. We are using the tier (product edition) name as the license config id such as `search` or `search_and_assistant`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Information about users' licenses.
+  "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
+    "alertEnrollments": [ # Optional. The enrollment state of each alert.
+      { # The alert enrollment status.
+        "alertId": "A String", # Immutable. The id of an alert.
+        "enrollState": "A String", # Required. The enrollment status of a customer.
+        "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
+          "a_key": "A String",
+        },
+      },
+    ],
+    "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+    "contactDetails": [ # Optional. The contact details for each alert policy.
+      { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
+        "emailAddress": "A String", # Optional. The email address of the contact.
+      },
+    ],
+    "languageCode": "A String", # Optional. The language code used for notifications
+  },
+  "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+  "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "freeTrial": True or False, # Optional. Whether the license config is for free trial.
+  "licenseCount": "A String", # Required. Number of licenses purchased.
+  "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
+  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "state": "A String", # Output only. The state of the license config.
+  "subscriptionTerm": "A String", # Required. Subscription term.
+  "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a LicenseConfig.
+
+Args:
+  name: string, Required. Full resource name of LicenseConfig, such as `projects/{project}/locations/{location}/licenseConfigs/*`. If the caller does not have permission to access the LicenseConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested LicenseConfig does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Information about users' licenses.
+  "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
+    "alertEnrollments": [ # Optional. The enrollment state of each alert.
+      { # The alert enrollment status.
+        "alertId": "A String", # Immutable. The id of an alert.
+        "enrollState": "A String", # Required. The enrollment status of a customer.
+        "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
+          "a_key": "A String",
+        },
+      },
+    ],
+    "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+    "contactDetails": [ # Optional. The contact details for each alert policy.
+      { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
+        "emailAddress": "A String", # Optional. The email address of the contact.
+      },
+    ],
+    "languageCode": "A String", # Optional. The language code used for notifications
+  },
+  "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+  "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "freeTrial": True or False, # Optional. Whether the license config is for free trial.
+  "licenseCount": "A String", # Required. Number of licenses purchased.
+  "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
+  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "state": "A String", # Output only. The state of the license config.
+  "subscriptionTerm": "A String", # Required. Subscription term.
+  "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
+}
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the LicenseConfig
+
+Args:
+  name: string, Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Information about users' licenses.
+  "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
+    "alertEnrollments": [ # Optional. The enrollment state of each alert.
+      { # The alert enrollment status.
+        "alertId": "A String", # Immutable. The id of an alert.
+        "enrollState": "A String", # Required. The enrollment status of a customer.
+        "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
+          "a_key": "A String",
+        },
+      },
+    ],
+    "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+    "contactDetails": [ # Optional. The contact details for each alert policy.
+      { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
+        "emailAddress": "A String", # Optional. The email address of the contact.
+      },
+    ],
+    "languageCode": "A String", # Optional. The language code used for notifications
+  },
+  "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+  "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "freeTrial": True or False, # Optional. Whether the license config is for free trial.
+  "licenseCount": "A String", # Required. Number of licenses purchased.
+  "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
+  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "state": "A String", # Output only. The state of the license config.
+  "subscriptionTerm": "A String", # Required. Subscription term.
+  "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
+}
+
+  updateMask: string, Optional. Indicates which fields in the provided LicenseConfig to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Information about users' licenses.
+  "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
+    "alertEnrollments": [ # Optional. The enrollment state of each alert.
+      { # The alert enrollment status.
+        "alertId": "A String", # Immutable. The id of an alert.
+        "enrollState": "A String", # Required. The enrollment status of a customer.
+        "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
+          "a_key": "A String",
+        },
+      },
+    ],
+    "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+    "contactDetails": [ # Optional. The contact details for each alert policy.
+      { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
+        "emailAddress": "A String", # Optional. The email address of the contact.
+      },
+    ],
+    "languageCode": "A String", # Optional. The language code used for notifications
+  },
+  "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+  "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "freeTrial": True or False, # Optional. Whether the license config is for free trial.
+  "licenseCount": "A String", # Required. Number of licenses purchased.
+  "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
+  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "state": "A String", # Output only. The state of the license config.
+  "subscriptionTerm": "A String", # Required. Subscription term.
+  "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/docs_v1.documents.html b/docs/dyn/docs_v1.documents.html index 6451707bb4..b58f53254b 100644 --- a/docs/dyn/docs_v1.documents.html +++ b/docs/dyn/docs_v1.documents.html @@ -236,6 +236,21 @@

Method Details

"tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, + "insertPerson": { # Inserts a person mention. # Inserts a person mention. + "endOfSegmentLocation": { # Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. # Inserts the person at the end of a header, footer, footnote or the document body. + "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. + }, + "location": { # A particular location in the document. # Inserts the person at a specific index in the document. The person mention must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). People cannot be inserted inside an equation. + "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. + "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. + }, + "personProperties": { # Properties specific to a linked Person. # The properties of the person mention to insert. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. + }, + }, "insertSectionBreak": { # Inserts a section break at the given location. A newline character will be inserted before the section break. # Inserts a section break at the specified location. "endOfSegmentLocation": { # Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. # Inserts a newline and a section break at the end of the document body. Section breaks cannot be inserted inside a footnote, header or footer. Because section breaks can only be inserted inside the body, the segment ID field must be empty. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. diff --git a/docs/dyn/documentai_v1.projects.locations.operations.html b/docs/dyn/documentai_v1.projects.locations.operations.html index 52a9ff24f8..41fb293951 100644 --- a/docs/dyn/documentai_v1.projects.locations.operations.html +++ b/docs/dyn/documentai_v1.projects.locations.operations.html @@ -84,7 +84,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -149,7 +149,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -157,6 +157,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -188,6 +189,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/documentai_v1beta3.projects.locations.operations.html b/docs/dyn/documentai_v1beta3.projects.locations.operations.html index aa1d6f6782..74c50b9560 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.operations.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.operations.html @@ -84,7 +84,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -149,7 +149,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -157,6 +157,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -188,6 +189,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/firebasehosting_v1.operations.html b/docs/dyn/firebasehosting_v1.operations.html index e3310ce93e..8754436c17 100644 --- a/docs/dyn/firebasehosting_v1.operations.html +++ b/docs/dyn/firebasehosting_v1.operations.html @@ -84,7 +84,7 @@

Instance Methods

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

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -138,7 +138,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -146,6 +146,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -177,6 +178,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/firebasehosting_v1beta1.projects.sites.customDomains.operations.html b/docs/dyn/firebasehosting_v1beta1.projects.sites.customDomains.operations.html index 126408928c..4e2ae9dd31 100644 --- a/docs/dyn/firebasehosting_v1beta1.projects.sites.customDomains.operations.html +++ b/docs/dyn/firebasehosting_v1beta1.projects.sites.customDomains.operations.html @@ -81,7 +81,7 @@

Instance Methods

get(name, x__xgafv=None)

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

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request.

list_next()

@@ -128,7 +128,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request.
 
 Args:
@@ -136,6 +136,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -167,6 +168,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/firebaseml_v1.operations.html b/docs/dyn/firebaseml_v1.operations.html index c477ff25a7..e5f20d503d 100644 --- a/docs/dyn/firebaseml_v1.operations.html +++ b/docs/dyn/firebaseml_v1.operations.html @@ -84,7 +84,7 @@

Instance Methods

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

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -138,7 +138,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -146,6 +146,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -177,6 +178,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html index b4de9ece61..8c0756436e 100644 --- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -156,6 +156,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -292,6 +295,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -386,6 +390,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -577,6 +582,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -738,6 +746,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -832,6 +841,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], @@ -1251,6 +1261,9 @@

Method Details

"candidateCount": 42, # Optional. Number of candidates to generate. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. "frequencyPenalty": 3.14, # Optional. Frequency penalties. + "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + }, "logprobs": 42, # Optional. Logit probabilities. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. @@ -1412,6 +1425,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. "A String", ], @@ -1506,6 +1520,7 @@

Method Details

"enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], diff --git a/docs/dyn/gkehub_v1.projects.locations.operations.html b/docs/dyn/gkehub_v1.projects.locations.operations.html index 9e3775093b..00cae22e7d 100644 --- a/docs/dyn/gkehub_v1.projects.locations.operations.html +++ b/docs/dyn/gkehub_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.operations.html b/docs/dyn/gkehub_v1alpha.projects.locations.operations.html index da10870678..b6312e5778 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.operations.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/gkehub_v1beta.projects.locations.operations.html b/docs/dyn/gkehub_v1beta.projects.locations.operations.html index dde5c8e61b..44c6ce87d7 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.operations.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/gkehub_v1beta1.projects.locations.operations.html b/docs/dyn/gkehub_v1beta1.projects.locations.operations.html index 2ff1adf4dd..ca8b39942e 100644 --- a/docs/dyn/gkehub_v1beta1.projects.locations.operations.html +++ b/docs/dyn/gkehub_v1beta1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/gkehub_v2.projects.locations.operations.html b/docs/dyn/gkehub_v2.projects.locations.operations.html index 203dd6d472..cfe38d6771 100644 --- a/docs/dyn/gkehub_v2.projects.locations.operations.html +++ b/docs/dyn/gkehub_v2.projects.locations.operations.html @@ -84,7 +84,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -155,7 +155,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -163,6 +163,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -194,6 +195,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/gkehub_v2alpha.projects.locations.operations.html b/docs/dyn/gkehub_v2alpha.projects.locations.operations.html index 366e3398c8..58d7161cb2 100644 --- a/docs/dyn/gkehub_v2alpha.projects.locations.operations.html +++ b/docs/dyn/gkehub_v2alpha.projects.locations.operations.html @@ -84,7 +84,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -155,7 +155,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -163,6 +163,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -194,6 +195,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/gkehub_v2beta.projects.locations.operations.html b/docs/dyn/gkehub_v2beta.projects.locations.operations.html index f804becdbc..2a156914f7 100644 --- a/docs/dyn/gkehub_v2beta.projects.locations.operations.html +++ b/docs/dyn/gkehub_v2beta.projects.locations.operations.html @@ -84,7 +84,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -155,7 +155,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -163,6 +163,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -194,6 +195,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html index 689efef38b..d4d57b9f28 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html @@ -122,13 +122,13 @@

Instance Methods

Updates the specified DICOM store.

searchForInstances(parent, dicomWebPath, x__xgafv=None)

-

SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

+

SearchForInstances returns a list of matching instances. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

searchForSeries(parent, dicomWebPath, x__xgafv=None)

-

SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

+

SearchForSeries returns a list of matching series. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

searchForStudies(parent, dicomWebPath, x__xgafv=None)

-

SearchForStudies returns a list of matching studies. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

+

SearchForStudies returns a list of matching studies. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

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

SetBlobStorageSettings sets the blob storage settings of the specified resources.

@@ -137,7 +137,7 @@

Instance Methods

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

storeInstances(parent, dicomWebPath, body=None, x__xgafv=None)

-

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).

+

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).

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.

@@ -230,16 +230,16 @@

Method Details

"dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Optional. Configures de-id of application/DICOM content. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags. - "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". + "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". "A String", ], }, "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags. - "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". + "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". "A String", ], }, - "skipIdRedaction": True or False, # Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html + "skipIdRedaction": True or False, # Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html }, "fhir": { # Specifies how to handle de-identification of a FHIR store. # Optional. Configures de-id of application/FHIR content. "defaultKeepExtensions": True or False, # Optional. The behaviour for handling FHIR extensions that aren't otherwise specified for de-identification. If true, all extensions are preserved during de-identification by default. If false or unspecified, all extensions are removed during de-identification by default. @@ -714,7 +714,7 @@

Method Details

searchForInstances(parent, dicomWebPath, x__xgafv=None) -
SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
+  
SearchForInstances returns a list of matching instances. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -740,7 +740,7 @@ 

Method Details

searchForSeries(parent, dicomWebPath, x__xgafv=None) -
SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
+  
SearchForSeries returns a list of matching series. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -766,7 +766,7 @@ 

Method Details

searchForStudies(parent, dicomWebPath, x__xgafv=None) -
SearchForStudies returns a list of matching studies. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
+  
SearchForStudies returns a list of matching studies. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -924,7 +924,7 @@ 

Method Details

storeInstances(parent, dicomWebPath, body=None, x__xgafv=None) -
StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).
+  
StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.html b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.html
index adb2bcc7e2..b2c728a8e0 100644
--- a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.html
+++ b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.html
@@ -87,19 +87,19 @@ 

Instance Methods

DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).

retrieveMetadata(parent, dicomWebPath, x__xgafv=None)

-

RetrieveStudyMetadata returns instance associated with the given study presented as metadata. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).

+

RetrieveStudyMetadata returns instance associated with the given study presented as metadata. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).

retrieveStudy(parent, dicomWebPath, x__xgafv=None)

-

RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).

+

RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).

searchForInstances(parent, dicomWebPath, x__xgafv=None)

-

SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

+

SearchForInstances returns a list of matching instances. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

searchForSeries(parent, dicomWebPath, x__xgafv=None)

-

SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

+

SearchForSeries returns a list of matching series. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

storeInstances(parent, dicomWebPath, body=None, x__xgafv=None)

-

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).

+

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).

Method Details

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

Method Details

retrieveMetadata(parent, dicomWebPath, x__xgafv=None) -
RetrieveStudyMetadata returns instance associated with the given study presented as metadata. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).
+  
RetrieveStudyMetadata returns instance associated with the given study presented as metadata. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -170,7 +170,7 @@ 

Method Details

retrieveStudy(parent, dicomWebPath, x__xgafv=None) -
RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).
+  
RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -196,7 +196,7 @@ 

Method Details

searchForInstances(parent, dicomWebPath, x__xgafv=None) -
SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
+  
SearchForInstances returns a list of matching instances. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -222,7 +222,7 @@ 

Method Details

searchForSeries(parent, dicomWebPath, x__xgafv=None) -
SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
+  
SearchForSeries returns a list of matching series. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -248,7 +248,7 @@ 

Method Details

storeInstances(parent, dicomWebPath, body=None, x__xgafv=None) -
StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).
+  
StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.html b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.html
index 42b3695299..0e4818e323 100644
--- a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.html
+++ b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.html
@@ -87,13 +87,13 @@ 

Instance Methods

DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).

retrieveMetadata(parent, dicomWebPath, x__xgafv=None)

-

RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).

+

RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).

retrieveSeries(parent, dicomWebPath, x__xgafv=None)

-

RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).

+

RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).

searchForInstances(parent, dicomWebPath, x__xgafv=None)

-

SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

+

SearchForInstances returns a list of matching instances. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

Method Details

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

Method Details

retrieveMetadata(parent, dicomWebPath, x__xgafv=None) -
RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).
+  
RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -164,7 +164,7 @@ 

Method Details

retrieveSeries(parent, dicomWebPath, x__xgafv=None) -
RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).
+  
RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -190,7 +190,7 @@ 

Method Details

searchForInstances(parent, dicomWebPath, x__xgafv=None) -
SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
+  
SearchForInstances returns a list of matching instances. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.instances.bulkdata.html b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.instances.bulkdata.html
index ff4ffa829f..27c9b65cf0 100644
--- a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.instances.bulkdata.html
+++ b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.instances.bulkdata.html
@@ -79,7 +79,7 @@ 

Instance Methods

Close httplib2 connections.

retrieveBulkdata(parent, dicomWebPath, x__xgafv=None)

-

Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See [Retrieve Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveBulkdata, see [Bulkdata resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see [Retrieve bulkdata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-bulkdata).

+

Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See [Retrieve Transaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveBulkdata, see [Bulkdata resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see [Retrieve bulkdata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-bulkdata).

Method Details

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

Method Details

retrieveBulkdata(parent, dicomWebPath, x__xgafv=None) -
Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See [Retrieve Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveBulkdata, see [Bulkdata resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see [Retrieve bulkdata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-bulkdata).
+  
Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See [Retrieve Transaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveBulkdata, see [Bulkdata resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see [Retrieve bulkdata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-bulkdata).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.instances.frames.html b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.instances.frames.html
index a46da7ec53..6a0b6207eb 100644
--- a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.instances.frames.html
+++ b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.instances.frames.html
@@ -79,10 +79,10 @@ 

Instance Methods

Close httplib2 connections.

retrieveFrames(parent, dicomWebPath, x__xgafv=None)

-

RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).

+

RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).

retrieveRendered(parent, dicomWebPath, viewport=None, x__xgafv=None)

-

RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).

+

RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).

Method Details

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

Method Details

retrieveFrames(parent, dicomWebPath, x__xgafv=None) -
RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).
+  
RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -117,7 +117,7 @@ 

Method Details

retrieveRendered(parent, dicomWebPath, viewport=None, x__xgafv=None) -
RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).
+  
RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.instances.html b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.instances.html
index 075b67e13f..a597cad22c 100644
--- a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.instances.html
+++ b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.instances.html
@@ -92,13 +92,13 @@ 

Instance Methods

DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).

retrieveInstance(parent, dicomWebPath, x__xgafv=None)

-

RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance).

+

RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance).

retrieveMetadata(parent, dicomWebPath, x__xgafv=None)

-

RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).

+

RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).

retrieveRendered(parent, dicomWebPath, viewport=None, x__xgafv=None)

-

RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).

+

RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).

Method Details

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

Method Details

retrieveInstance(parent, dicomWebPath, x__xgafv=None) -
RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance).
+  
RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -152,7 +152,7 @@ 

Method Details

retrieveMetadata(parent, dicomWebPath, x__xgafv=None) -
RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).
+  
RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -178,7 +178,7 @@ 

Method Details

retrieveRendered(parent, dicomWebPath, viewport=None, x__xgafv=None) -
RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).
+  
RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html
index 4e67ddd897..28c941ff19 100644
--- a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html
+++ b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html
@@ -340,16 +340,16 @@ 

Method Details

"dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Optional. Configures de-id of application/DICOM content. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags. - "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". + "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". "A String", ], }, "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags. - "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". + "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". "A String", ], }, - "skipIdRedaction": True or False, # Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html + "skipIdRedaction": True or False, # Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html }, "fhir": { # Specifies how to handle de-identification of a FHIR store. # Optional. Configures de-id of application/FHIR content. "defaultKeepExtensions": True or False, # Optional. The behaviour for handling FHIR extensions that aren't otherwise specified for de-identification. If true, all extensions are preserved during de-identification by default. If false or unspecified, all extensions are removed during de-identification by default. @@ -513,16 +513,16 @@

Method Details

"dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Optional. Configures de-id of application/DICOM content. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags. - "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". + "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". "A String", ], }, "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags. - "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". + "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". "A String", ], }, - "skipIdRedaction": True or False, # Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html + "skipIdRedaction": True or False, # Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html }, "fhir": { # Specifies how to handle de-identification of a FHIR store. # Optional. Configures de-id of application/FHIR content. "defaultKeepExtensions": True or False, # Optional. The behaviour for handling FHIR extensions that aren't otherwise specified for de-identification. If true, all extensions are preserved during de-identification by default. If false or unspecified, all extensions are removed during de-identification by default. @@ -635,16 +635,16 @@

Method Details

"dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Optional. Configures de-id of application/DICOM content. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags. - "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". + "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". "A String", ], }, "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags. - "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". + "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". "A String", ], }, - "skipIdRedaction": True or False, # Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html + "skipIdRedaction": True or False, # Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html }, "fhir": { # Specifies how to handle de-identification of a FHIR store. # Optional. Configures de-id of application/FHIR content. "defaultKeepExtensions": True or False, # Optional. The behaviour for handling FHIR extensions that aren't otherwise specified for de-identification. If true, all extensions are preserved during de-identification by default. If false or unspecified, all extensions are removed during de-identification by default. @@ -966,16 +966,16 @@

Method Details

"dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Optional. Configures de-id of application/DICOM content. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags. - "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". + "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". "A String", ], }, "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags. - "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". + "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". "A String", ], }, - "skipIdRedaction": True or False, # Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html + "skipIdRedaction": True or False, # Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html }, "fhir": { # Specifies how to handle de-identification of a FHIR store. # Optional. Configures de-id of application/FHIR content. "defaultKeepExtensions": True or False, # Optional. The behaviour for handling FHIR extensions that aren't otherwise specified for de-identification. If true, all extensions are preserved during de-identification by default. If false or unspecified, all extensions are removed during de-identification by default. @@ -1269,16 +1269,16 @@

Method Details

"dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Optional. Configures de-id of application/DICOM content. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags. - "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". + "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". "A String", ], }, "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags. - "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". + "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". "A String", ], }, - "skipIdRedaction": True or False, # Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html + "skipIdRedaction": True or False, # Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html }, "fhir": { # Specifies how to handle de-identification of a FHIR store. # Optional. Configures de-id of application/FHIR content. "defaultKeepExtensions": True or False, # Optional. The behaviour for handling FHIR extensions that aren't otherwise specified for de-identification. If true, all extensions are preserved during de-identification by default. If false or unspecified, all extensions are removed during de-identification by default. @@ -1460,16 +1460,16 @@

Method Details

"dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Optional. Configures de-id of application/DICOM content. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags. - "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". + "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". "A String", ], }, "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags. - "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". + "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". "A String", ], }, - "skipIdRedaction": True or False, # Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html + "skipIdRedaction": True or False, # Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html }, "fhir": { # Specifies how to handle de-identification of a FHIR store. # Optional. Configures de-id of application/FHIR content. "defaultKeepExtensions": True or False, # Optional. The behaviour for handling FHIR extensions that aren't otherwise specified for de-identification. If true, all extensions are preserved during de-identification by default. If false or unspecified, all extensions are removed during de-identification by default. @@ -1633,16 +1633,16 @@

Method Details

"dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Optional. Configures de-id of application/DICOM content. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags. - "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". + "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". "A String", ], }, "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags. - "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". + "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". "A String", ], }, - "skipIdRedaction": True or False, # Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html + "skipIdRedaction": True or False, # Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html }, "fhir": { # Specifies how to handle de-identification of a FHIR store. # Optional. Configures de-id of application/FHIR content. "defaultKeepExtensions": True or False, # Optional. The behaviour for handling FHIR extensions that aren't otherwise specified for de-identification. If true, all extensions are preserved during de-identification by default. If false or unspecified, all extensions are removed during de-identification by default. diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.html b/docs/dyn/healthcare_v1.projects.locations.datasets.html index cd8f57e9e2..78e8e9fa9a 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.html @@ -206,16 +206,16 @@

Method Details

"dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Optional. Configures de-id of application/DICOM content. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags. - "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". + "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". "A String", ], }, "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags. - "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". + "tags": [ # Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". "A String", ], }, - "skipIdRedaction": True or False, # Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html + "skipIdRedaction": True or False, # Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html }, "fhir": { # Specifies how to handle de-identification of a FHIR store. # Optional. Configures de-id of application/FHIR content. "defaultKeepExtensions": True or False, # Optional. The behaviour for handling FHIR extensions that aren't otherwise specified for de-identification. If true, all extensions are preserved during de-identification by default. If false or unspecified, all extensions are removed during de-identification by default. diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html index 560f8b2534..db82bc43fc 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html @@ -122,13 +122,13 @@

Instance Methods

Updates the specified DICOM store.

searchForInstances(parent, dicomWebPath, x__xgafv=None)

-

SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

+

SearchForInstances returns a list of matching instances. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

searchForSeries(parent, dicomWebPath, x__xgafv=None)

-

SearchForSeries returns a list of matching series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

+

SearchForSeries returns a list of matching series. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

searchForStudies(parent, dicomWebPath, x__xgafv=None)

-

SearchForStudies returns a list of matching studies. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

+

SearchForStudies returns a list of matching studies. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

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

SetBlobStorageSettings sets the blob storage settings of the specified resources.

@@ -137,7 +137,7 @@

Instance Methods

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

storeInstances(parent, dicomWebPath, body=None, x__xgafv=None)

-

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).

+

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).

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.

@@ -233,21 +233,21 @@

Method Details

"dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Configures de-id of application/DICOM content. Deprecated. Use `dicom_tag_config` instead. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags. - "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". + "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". "A String", ], }, "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags. - "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". + "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". "A String", ], }, - "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html + "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html }, "dicomTagConfig": { # Specifies the parameters needed for the de-identification of DICOM stores. # Configures de-id of application/DICOM content. "actions": [ # Specifies custom tag selections and `Actions` to apply to them. Overrides `options` and `profile`. Conflicting `Actions` are applied in the order given. { # Specifies a selection of tags and an `Action` to apply to each one. - "cleanImageTag": { # Specifies how to handle de-identification of image pixels. # Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData + "cleanImageTag": { # Specifies how to handle de-identification of image pixels. # Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData "additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], @@ -256,7 +256,7 @@

Method Details

], "textRedactionMode": "A String", # Determines how to redact text from image. }, - "cleanTextTag": { # Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS # Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS + "cleanTextTag": { # Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS # Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS }, "deleteTag": { # Delete tag. # Delete tag. }, @@ -265,9 +265,9 @@

Method Details

"queries": [ # Select all tags with the listed tag IDs, names, or Value Representations (VRs). Examples: ID: "00100010" Keyword: "PatientName" VR: "PN" "A String", ], - "recurseTag": { # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ + "recurseTag": { # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ }, - "regenUidTag": { # Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI # Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI + "regenUidTag": { # Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI # Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI }, "removeTag": { # Replace with empty tag. # Replace with empty tag. }, @@ -276,9 +276,9 @@

Method Details

}, ], "options": { # Specifies additional options to apply to the base profile. # Specifies additional options to apply, overriding the base `profile`. - "cleanDescriptors": { # This option is based on the DICOM Standard's [Clean Descriptors Option](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This option uses an additional infoType during inspection. # Set Clean Descriptors Option. + "cleanDescriptors": { # This option is based on the DICOM Standard's [Clean Descriptors Option](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This option uses an additional infoType during inspection. # Set Clean Descriptors Option. }, - "cleanImage": { # Specifies how to handle de-identification of image pixels. # Apply `Action.clean_image` to [`PixelData`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured. + "cleanImage": { # Specifies how to handle de-identification of image pixels. # Apply `Action.clean_image` to [`PixelData`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured. "additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], @@ -287,7 +287,7 @@

Method Details

], "textRedactionMode": "A String", # Determines how to redact text from image. }, - "primaryIds": "A String", # Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html). + "primaryIds": "A String", # Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html). }, "profileType": "A String", # Base profile type for handling DICOM tags. }, @@ -824,7 +824,7 @@

Method Details

searchForInstances(parent, dicomWebPath, x__xgafv=None) -
SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
+  
SearchForInstances returns a list of matching instances. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -850,7 +850,7 @@ 

Method Details

searchForSeries(parent, dicomWebPath, x__xgafv=None) -
SearchForSeries returns a list of matching series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
+  
SearchForSeries returns a list of matching series. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -876,7 +876,7 @@ 

Method Details

searchForStudies(parent, dicomWebPath, x__xgafv=None) -
SearchForStudies returns a list of matching studies. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
+  
SearchForStudies returns a list of matching studies. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -1034,7 +1034,7 @@ 

Method Details

storeInstances(parent, dicomWebPath, body=None, x__xgafv=None) -
StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).
+  
StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.html
index ff8946c73b..f0caf80456 100644
--- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.html
+++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.html
@@ -87,19 +87,19 @@ 

Instance Methods

DeleteStudy deletes all instances within the given study using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).

retrieveMetadata(parent, dicomWebPath, x__xgafv=None)

-

RetrieveStudyMetadata returns instance associated with the given study presented as metadata. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).

+

RetrieveStudyMetadata returns instance associated with the given study presented as metadata. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).

retrieveStudy(parent, dicomWebPath, x__xgafv=None)

-

RetrieveStudy returns all instances within the given study. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).

+

RetrieveStudy returns all instances within the given study. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).

searchForInstances(parent, dicomWebPath, x__xgafv=None)

-

SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

+

SearchForInstances returns a list of matching instances. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

searchForSeries(parent, dicomWebPath, x__xgafv=None)

-

SearchForSeries returns a list of matching series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

+

SearchForSeries returns a list of matching series. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

storeInstances(parent, dicomWebPath, body=None, x__xgafv=None)

-

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).

+

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).

updateInstances(parent, dicomWebPath, body=None, x__xgafv=None)

UpdateInstances updates DICOM instances associated with study instance unique identifiers (SUID).

@@ -150,7 +150,7 @@

Method Details

retrieveMetadata(parent, dicomWebPath, x__xgafv=None) -
RetrieveStudyMetadata returns instance associated with the given study presented as metadata. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).
+  
RetrieveStudyMetadata returns instance associated with the given study presented as metadata. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -176,7 +176,7 @@ 

Method Details

retrieveStudy(parent, dicomWebPath, x__xgafv=None) -
RetrieveStudy returns all instances within the given study. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).
+  
RetrieveStudy returns all instances within the given study. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -202,7 +202,7 @@ 

Method Details

searchForInstances(parent, dicomWebPath, x__xgafv=None) -
SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
+  
SearchForInstances returns a list of matching instances. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -228,7 +228,7 @@ 

Method Details

searchForSeries(parent, dicomWebPath, x__xgafv=None) -
SearchForSeries returns a list of matching series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
+  
SearchForSeries returns a list of matching series. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -254,7 +254,7 @@ 

Method Details

storeInstances(parent, dicomWebPath, body=None, x__xgafv=None) -
StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).
+  
StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.html
index c760a72baf..9c3239aee1 100644
--- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.html
+++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.html
@@ -87,13 +87,13 @@ 

Instance Methods

DeleteSeries deletes all instances within the given study and series using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).

retrieveMetadata(parent, dicomWebPath, x__xgafv=None)

-

RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).

+

RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).

retrieveSeries(parent, dicomWebPath, x__xgafv=None)

-

RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).

+

RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).

searchForInstances(parent, dicomWebPath, x__xgafv=None)

-

SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

+

SearchForInstances returns a list of matching instances. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

updateMetadata(parent, dicomWebPath, body=None, x__xgafv=None)

UpdateSeriesMetadata modifies the metadata of all instances in the given series. The request body must contain a JSON Patch document specifying the updates to be applied to the metadata of all instances within the series.

@@ -141,7 +141,7 @@

Method Details

retrieveMetadata(parent, dicomWebPath, x__xgafv=None) -
RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).
+  
RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -167,7 +167,7 @@ 

Method Details

retrieveSeries(parent, dicomWebPath, x__xgafv=None) -
RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).
+  
RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -193,7 +193,7 @@ 

Method Details

searchForInstances(parent, dicomWebPath, x__xgafv=None) -
SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
+  
SearchForInstances returns a list of matching instances. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.instances.bulkdata.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.instances.bulkdata.html
index 91f607c892..870ee01c44 100644
--- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.instances.bulkdata.html
+++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.instances.bulkdata.html
@@ -79,7 +79,7 @@ 

Instance Methods

Close httplib2 connections.

retrieveBulkdata(parent, dicomWebPath, x__xgafv=None)

-

Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See [Retrieve Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveBulkdata, see [Bulkdata resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see [Retrieve bulkdata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-bulkdata).

+

Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See [Retrieve Transaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveBulkdata, see [Bulkdata resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see [Retrieve bulkdata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-bulkdata).

Method Details

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

Method Details

retrieveBulkdata(parent, dicomWebPath, x__xgafv=None) -
Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See [Retrieve Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveBulkdata, see [Bulkdata resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see [Retrieve bulkdata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-bulkdata).
+  
Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See [Retrieve Transaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveBulkdata, see [Bulkdata resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see [Retrieve bulkdata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-bulkdata).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.instances.frames.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.instances.frames.html
index 277227032b..9eb18170a4 100644
--- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.instances.frames.html
+++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.instances.frames.html
@@ -79,10 +79,10 @@ 

Instance Methods

Close httplib2 connections.

retrieveFrames(parent, dicomWebPath, x__xgafv=None)

-

RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).

+

RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).

retrieveRendered(parent, dicomWebPath, viewport=None, x__xgafv=None)

-

RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).

+

RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).

Method Details

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

Method Details

retrieveFrames(parent, dicomWebPath, x__xgafv=None) -
RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).
+  
RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -117,7 +117,7 @@ 

Method Details

retrieveRendered(parent, dicomWebPath, viewport=None, x__xgafv=None) -
RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).
+  
RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.instances.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.instances.html
index 5bd329f43e..d25eb41bae 100644
--- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.instances.html
+++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.instances.html
@@ -92,13 +92,13 @@ 

Instance Methods

DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).

retrieveInstance(parent, dicomWebPath, x__xgafv=None)

-

RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance).

+

RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance).

retrieveMetadata(parent, dicomWebPath, x__xgafv=None)

-

RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).

+

RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).

retrieveRendered(parent, dicomWebPath, viewport=None, x__xgafv=None)

-

RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).

+

RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).

updateMetadata(parent, dicomWebPath, body=None, x__xgafv=None)

UpdateInstanceMetadata modifies the metadata of a single instance. The request body must contain a JSON Patch document specifying the updates to be applied to the metadata of the instance.

@@ -129,7 +129,7 @@

Method Details

retrieveInstance(parent, dicomWebPath, x__xgafv=None) -
RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance).
+  
RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -155,7 +155,7 @@ 

Method Details

retrieveMetadata(parent, dicomWebPath, x__xgafv=None) -
RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).
+  
RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
@@ -181,7 +181,7 @@ 

Method Details

retrieveRendered(parent, dicomWebPath, viewport=None, x__xgafv=None) -
RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).
+  
RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).
 
 Args:
   parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html
index 87292d7c74..4dc2869e3e 100644
--- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html
+++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html
@@ -406,21 +406,21 @@ 

Method Details

"dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Configures de-id of application/DICOM content. Deprecated. Use `dicom_tag_config` instead. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags. - "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". + "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". "A String", ], }, "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags. - "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". + "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". "A String", ], }, - "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html + "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html }, "dicomTagConfig": { # Specifies the parameters needed for the de-identification of DICOM stores. # Configures de-id of application/DICOM content. "actions": [ # Specifies custom tag selections and `Actions` to apply to them. Overrides `options` and `profile`. Conflicting `Actions` are applied in the order given. { # Specifies a selection of tags and an `Action` to apply to each one. - "cleanImageTag": { # Specifies how to handle de-identification of image pixels. # Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData + "cleanImageTag": { # Specifies how to handle de-identification of image pixels. # Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData "additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], @@ -429,7 +429,7 @@

Method Details

], "textRedactionMode": "A String", # Determines how to redact text from image. }, - "cleanTextTag": { # Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS # Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS + "cleanTextTag": { # Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS # Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS }, "deleteTag": { # Delete tag. # Delete tag. }, @@ -438,9 +438,9 @@

Method Details

"queries": [ # Select all tags with the listed tag IDs, names, or Value Representations (VRs). Examples: ID: "00100010" Keyword: "PatientName" VR: "PN" "A String", ], - "recurseTag": { # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ + "recurseTag": { # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ }, - "regenUidTag": { # Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI # Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI + "regenUidTag": { # Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI # Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI }, "removeTag": { # Replace with empty tag. # Replace with empty tag. }, @@ -449,9 +449,9 @@

Method Details

}, ], "options": { # Specifies additional options to apply to the base profile. # Specifies additional options to apply, overriding the base `profile`. - "cleanDescriptors": { # This option is based on the DICOM Standard's [Clean Descriptors Option](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This option uses an additional infoType during inspection. # Set Clean Descriptors Option. + "cleanDescriptors": { # This option is based on the DICOM Standard's [Clean Descriptors Option](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This option uses an additional infoType during inspection. # Set Clean Descriptors Option. }, - "cleanImage": { # Specifies how to handle de-identification of image pixels. # Apply `Action.clean_image` to [`PixelData`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured. + "cleanImage": { # Specifies how to handle de-identification of image pixels. # Apply `Action.clean_image` to [`PixelData`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured. "additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], @@ -460,7 +460,7 @@

Method Details

], "textRedactionMode": "A String", # Determines how to redact text from image. }, - "primaryIds": "A String", # Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html). + "primaryIds": "A String", # Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html). }, "profileType": "A String", # Base profile type for handling DICOM tags. }, @@ -695,21 +695,21 @@

Method Details

"dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Configures de-id of application/DICOM content. Deprecated. Use `dicom_tag_config` instead. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags. - "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". + "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". "A String", ], }, "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags. - "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". + "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". "A String", ], }, - "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html + "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html }, "dicomTagConfig": { # Specifies the parameters needed for the de-identification of DICOM stores. # Configures de-id of application/DICOM content. "actions": [ # Specifies custom tag selections and `Actions` to apply to them. Overrides `options` and `profile`. Conflicting `Actions` are applied in the order given. { # Specifies a selection of tags and an `Action` to apply to each one. - "cleanImageTag": { # Specifies how to handle de-identification of image pixels. # Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData + "cleanImageTag": { # Specifies how to handle de-identification of image pixels. # Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData "additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], @@ -718,7 +718,7 @@

Method Details

], "textRedactionMode": "A String", # Determines how to redact text from image. }, - "cleanTextTag": { # Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS # Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS + "cleanTextTag": { # Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS # Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS }, "deleteTag": { # Delete tag. # Delete tag. }, @@ -727,9 +727,9 @@

Method Details

"queries": [ # Select all tags with the listed tag IDs, names, or Value Representations (VRs). Examples: ID: "00100010" Keyword: "PatientName" VR: "PN" "A String", ], - "recurseTag": { # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ + "recurseTag": { # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ }, - "regenUidTag": { # Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI # Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI + "regenUidTag": { # Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI # Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI }, "removeTag": { # Replace with empty tag. # Replace with empty tag. }, @@ -738,9 +738,9 @@

Method Details

}, ], "options": { # Specifies additional options to apply to the base profile. # Specifies additional options to apply, overriding the base `profile`. - "cleanDescriptors": { # This option is based on the DICOM Standard's [Clean Descriptors Option](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This option uses an additional infoType during inspection. # Set Clean Descriptors Option. + "cleanDescriptors": { # This option is based on the DICOM Standard's [Clean Descriptors Option](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This option uses an additional infoType during inspection. # Set Clean Descriptors Option. }, - "cleanImage": { # Specifies how to handle de-identification of image pixels. # Apply `Action.clean_image` to [`PixelData`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured. + "cleanImage": { # Specifies how to handle de-identification of image pixels. # Apply `Action.clean_image` to [`PixelData`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured. "additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], @@ -749,7 +749,7 @@

Method Details

], "textRedactionMode": "A String", # Determines how to redact text from image. }, - "primaryIds": "A String", # Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html). + "primaryIds": "A String", # Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html). }, "profileType": "A String", # Base profile type for handling DICOM tags. }, @@ -921,21 +921,21 @@

Method Details

"dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Configures de-id of application/DICOM content. Deprecated. Use `dicom_tag_config` instead. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags. - "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". + "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". "A String", ], }, "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags. - "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". + "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". "A String", ], }, - "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html + "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html }, "dicomTagConfig": { # Specifies the parameters needed for the de-identification of DICOM stores. # Configures de-id of application/DICOM content. "actions": [ # Specifies custom tag selections and `Actions` to apply to them. Overrides `options` and `profile`. Conflicting `Actions` are applied in the order given. { # Specifies a selection of tags and an `Action` to apply to each one. - "cleanImageTag": { # Specifies how to handle de-identification of image pixels. # Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData + "cleanImageTag": { # Specifies how to handle de-identification of image pixels. # Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData "additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], @@ -944,7 +944,7 @@

Method Details

], "textRedactionMode": "A String", # Determines how to redact text from image. }, - "cleanTextTag": { # Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS # Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS + "cleanTextTag": { # Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS # Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS }, "deleteTag": { # Delete tag. # Delete tag. }, @@ -953,9 +953,9 @@

Method Details

"queries": [ # Select all tags with the listed tag IDs, names, or Value Representations (VRs). Examples: ID: "00100010" Keyword: "PatientName" VR: "PN" "A String", ], - "recurseTag": { # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ + "recurseTag": { # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ }, - "regenUidTag": { # Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI # Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI + "regenUidTag": { # Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI # Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI }, "removeTag": { # Replace with empty tag. # Replace with empty tag. }, @@ -964,9 +964,9 @@

Method Details

}, ], "options": { # Specifies additional options to apply to the base profile. # Specifies additional options to apply, overriding the base `profile`. - "cleanDescriptors": { # This option is based on the DICOM Standard's [Clean Descriptors Option](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This option uses an additional infoType during inspection. # Set Clean Descriptors Option. + "cleanDescriptors": { # This option is based on the DICOM Standard's [Clean Descriptors Option](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This option uses an additional infoType during inspection. # Set Clean Descriptors Option. }, - "cleanImage": { # Specifies how to handle de-identification of image pixels. # Apply `Action.clean_image` to [`PixelData`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured. + "cleanImage": { # Specifies how to handle de-identification of image pixels. # Apply `Action.clean_image` to [`PixelData`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured. "additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], @@ -975,7 +975,7 @@

Method Details

], "textRedactionMode": "A String", # Determines how to redact text from image. }, - "primaryIds": "A String", # Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html). + "primaryIds": "A String", # Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html). }, "profileType": "A String", # Base profile type for handling DICOM tags. }, @@ -1418,21 +1418,21 @@

Method Details

"dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Configures de-id of application/DICOM content. Deprecated. Use `dicom_tag_config` instead. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags. - "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". + "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". "A String", ], }, "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags. - "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". + "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". "A String", ], }, - "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html + "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html }, "dicomTagConfig": { # Specifies the parameters needed for the de-identification of DICOM stores. # Configures de-id of application/DICOM content. "actions": [ # Specifies custom tag selections and `Actions` to apply to them. Overrides `options` and `profile`. Conflicting `Actions` are applied in the order given. { # Specifies a selection of tags and an `Action` to apply to each one. - "cleanImageTag": { # Specifies how to handle de-identification of image pixels. # Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData + "cleanImageTag": { # Specifies how to handle de-identification of image pixels. # Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData "additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], @@ -1441,7 +1441,7 @@

Method Details

], "textRedactionMode": "A String", # Determines how to redact text from image. }, - "cleanTextTag": { # Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS # Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS + "cleanTextTag": { # Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS # Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS }, "deleteTag": { # Delete tag. # Delete tag. }, @@ -1450,9 +1450,9 @@

Method Details

"queries": [ # Select all tags with the listed tag IDs, names, or Value Representations (VRs). Examples: ID: "00100010" Keyword: "PatientName" VR: "PN" "A String", ], - "recurseTag": { # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ + "recurseTag": { # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ }, - "regenUidTag": { # Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI # Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI + "regenUidTag": { # Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI # Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI }, "removeTag": { # Replace with empty tag. # Replace with empty tag. }, @@ -1461,9 +1461,9 @@

Method Details

}, ], "options": { # Specifies additional options to apply to the base profile. # Specifies additional options to apply, overriding the base `profile`. - "cleanDescriptors": { # This option is based on the DICOM Standard's [Clean Descriptors Option](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This option uses an additional infoType during inspection. # Set Clean Descriptors Option. + "cleanDescriptors": { # This option is based on the DICOM Standard's [Clean Descriptors Option](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This option uses an additional infoType during inspection. # Set Clean Descriptors Option. }, - "cleanImage": { # Specifies how to handle de-identification of image pixels. # Apply `Action.clean_image` to [`PixelData`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured. + "cleanImage": { # Specifies how to handle de-identification of image pixels. # Apply `Action.clean_image` to [`PixelData`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured. "additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], @@ -1472,7 +1472,7 @@

Method Details

], "textRedactionMode": "A String", # Determines how to redact text from image. }, - "primaryIds": "A String", # Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html). + "primaryIds": "A String", # Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html). }, "profileType": "A String", # Base profile type for handling DICOM tags. }, @@ -1883,21 +1883,21 @@

Method Details

"dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Configures de-id of application/DICOM content. Deprecated. Use `dicom_tag_config` instead. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags. - "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". + "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". "A String", ], }, "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags. - "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". + "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". "A String", ], }, - "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html + "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html }, "dicomTagConfig": { # Specifies the parameters needed for the de-identification of DICOM stores. # Configures de-id of application/DICOM content. "actions": [ # Specifies custom tag selections and `Actions` to apply to them. Overrides `options` and `profile`. Conflicting `Actions` are applied in the order given. { # Specifies a selection of tags and an `Action` to apply to each one. - "cleanImageTag": { # Specifies how to handle de-identification of image pixels. # Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData + "cleanImageTag": { # Specifies how to handle de-identification of image pixels. # Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData "additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], @@ -1906,7 +1906,7 @@

Method Details

], "textRedactionMode": "A String", # Determines how to redact text from image. }, - "cleanTextTag": { # Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS # Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS + "cleanTextTag": { # Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS # Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS }, "deleteTag": { # Delete tag. # Delete tag. }, @@ -1915,9 +1915,9 @@

Method Details

"queries": [ # Select all tags with the listed tag IDs, names, or Value Representations (VRs). Examples: ID: "00100010" Keyword: "PatientName" VR: "PN" "A String", ], - "recurseTag": { # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ + "recurseTag": { # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ }, - "regenUidTag": { # Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI # Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI + "regenUidTag": { # Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI # Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI }, "removeTag": { # Replace with empty tag. # Replace with empty tag. }, @@ -1926,9 +1926,9 @@

Method Details

}, ], "options": { # Specifies additional options to apply to the base profile. # Specifies additional options to apply, overriding the base `profile`. - "cleanDescriptors": { # This option is based on the DICOM Standard's [Clean Descriptors Option](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This option uses an additional infoType during inspection. # Set Clean Descriptors Option. + "cleanDescriptors": { # This option is based on the DICOM Standard's [Clean Descriptors Option](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This option uses an additional infoType during inspection. # Set Clean Descriptors Option. }, - "cleanImage": { # Specifies how to handle de-identification of image pixels. # Apply `Action.clean_image` to [`PixelData`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured. + "cleanImage": { # Specifies how to handle de-identification of image pixels. # Apply `Action.clean_image` to [`PixelData`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured. "additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], @@ -1937,7 +1937,7 @@

Method Details

], "textRedactionMode": "A String", # Determines how to redact text from image. }, - "primaryIds": "A String", # Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html). + "primaryIds": "A String", # Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html). }, "profileType": "A String", # Base profile type for handling DICOM tags. }, @@ -2190,21 +2190,21 @@

Method Details

"dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Configures de-id of application/DICOM content. Deprecated. Use `dicom_tag_config` instead. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags. - "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". + "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". "A String", ], }, "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags. - "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". + "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". "A String", ], }, - "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html + "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html }, "dicomTagConfig": { # Specifies the parameters needed for the de-identification of DICOM stores. # Configures de-id of application/DICOM content. "actions": [ # Specifies custom tag selections and `Actions` to apply to them. Overrides `options` and `profile`. Conflicting `Actions` are applied in the order given. { # Specifies a selection of tags and an `Action` to apply to each one. - "cleanImageTag": { # Specifies how to handle de-identification of image pixels. # Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData + "cleanImageTag": { # Specifies how to handle de-identification of image pixels. # Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData "additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], @@ -2213,7 +2213,7 @@

Method Details

], "textRedactionMode": "A String", # Determines how to redact text from image. }, - "cleanTextTag": { # Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS # Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS + "cleanTextTag": { # Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS # Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS }, "deleteTag": { # Delete tag. # Delete tag. }, @@ -2222,9 +2222,9 @@

Method Details

"queries": [ # Select all tags with the listed tag IDs, names, or Value Representations (VRs). Examples: ID: "00100010" Keyword: "PatientName" VR: "PN" "A String", ], - "recurseTag": { # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ + "recurseTag": { # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ }, - "regenUidTag": { # Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI # Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI + "regenUidTag": { # Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI # Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI }, "removeTag": { # Replace with empty tag. # Replace with empty tag. }, @@ -2233,9 +2233,9 @@

Method Details

}, ], "options": { # Specifies additional options to apply to the base profile. # Specifies additional options to apply, overriding the base `profile`. - "cleanDescriptors": { # This option is based on the DICOM Standard's [Clean Descriptors Option](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This option uses an additional infoType during inspection. # Set Clean Descriptors Option. + "cleanDescriptors": { # This option is based on the DICOM Standard's [Clean Descriptors Option](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This option uses an additional infoType during inspection. # Set Clean Descriptors Option. }, - "cleanImage": { # Specifies how to handle de-identification of image pixels. # Apply `Action.clean_image` to [`PixelData`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured. + "cleanImage": { # Specifies how to handle de-identification of image pixels. # Apply `Action.clean_image` to [`PixelData`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured. "additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], @@ -2244,7 +2244,7 @@

Method Details

], "textRedactionMode": "A String", # Determines how to redact text from image. }, - "primaryIds": "A String", # Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html). + "primaryIds": "A String", # Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html). }, "profileType": "A String", # Base profile type for handling DICOM tags. }, @@ -2479,21 +2479,21 @@

Method Details

"dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Configures de-id of application/DICOM content. Deprecated. Use `dicom_tag_config` instead. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags. - "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". + "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". "A String", ], }, "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags. - "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". + "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". "A String", ], }, - "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html + "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html }, "dicomTagConfig": { # Specifies the parameters needed for the de-identification of DICOM stores. # Configures de-id of application/DICOM content. "actions": [ # Specifies custom tag selections and `Actions` to apply to them. Overrides `options` and `profile`. Conflicting `Actions` are applied in the order given. { # Specifies a selection of tags and an `Action` to apply to each one. - "cleanImageTag": { # Specifies how to handle de-identification of image pixels. # Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData + "cleanImageTag": { # Specifies how to handle de-identification of image pixels. # Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData "additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], @@ -2502,7 +2502,7 @@

Method Details

], "textRedactionMode": "A String", # Determines how to redact text from image. }, - "cleanTextTag": { # Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS # Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS + "cleanTextTag": { # Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS # Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS }, "deleteTag": { # Delete tag. # Delete tag. }, @@ -2511,9 +2511,9 @@

Method Details

"queries": [ # Select all tags with the listed tag IDs, names, or Value Representations (VRs). Examples: ID: "00100010" Keyword: "PatientName" VR: "PN" "A String", ], - "recurseTag": { # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ + "recurseTag": { # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ }, - "regenUidTag": { # Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI # Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI + "regenUidTag": { # Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI # Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI }, "removeTag": { # Replace with empty tag. # Replace with empty tag. }, @@ -2522,9 +2522,9 @@

Method Details

}, ], "options": { # Specifies additional options to apply to the base profile. # Specifies additional options to apply, overriding the base `profile`. - "cleanDescriptors": { # This option is based on the DICOM Standard's [Clean Descriptors Option](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This option uses an additional infoType during inspection. # Set Clean Descriptors Option. + "cleanDescriptors": { # This option is based on the DICOM Standard's [Clean Descriptors Option](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This option uses an additional infoType during inspection. # Set Clean Descriptors Option. }, - "cleanImage": { # Specifies how to handle de-identification of image pixels. # Apply `Action.clean_image` to [`PixelData`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured. + "cleanImage": { # Specifies how to handle de-identification of image pixels. # Apply `Action.clean_image` to [`PixelData`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured. "additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], @@ -2533,7 +2533,7 @@

Method Details

], "textRedactionMode": "A String", # Determines how to redact text from image. }, - "primaryIds": "A String", # Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html). + "primaryIds": "A String", # Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html). }, "profileType": "A String", # Base profile type for handling DICOM tags. }, diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html index 57b9387087..b5d1ef4589 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html @@ -206,21 +206,21 @@

Method Details

"dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Configures de-id of application/DICOM content. Deprecated. Use `dicom_tag_config` instead. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags. - "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". + "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". "A String", ], }, "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags. - "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". + "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010". "A String", ], }, - "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html + "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html }, "dicomTagConfig": { # Specifies the parameters needed for the de-identification of DICOM stores. # Configures de-id of application/DICOM content. "actions": [ # Specifies custom tag selections and `Actions` to apply to them. Overrides `options` and `profile`. Conflicting `Actions` are applied in the order given. { # Specifies a selection of tags and an `Action` to apply to each one. - "cleanImageTag": { # Specifies how to handle de-identification of image pixels. # Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData + "cleanImageTag": { # Specifies how to handle de-identification of image pixels. # Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData "additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], @@ -229,7 +229,7 @@

Method Details

], "textRedactionMode": "A String", # Determines how to redact text from image. }, - "cleanTextTag": { # Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS # Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS + "cleanTextTag": { # Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS # Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS }, "deleteTag": { # Delete tag. # Delete tag. }, @@ -238,9 +238,9 @@

Method Details

"queries": [ # Select all tags with the listed tag IDs, names, or Value Representations (VRs). Examples: ID: "00100010" Keyword: "PatientName" VR: "PN" "A String", ], - "recurseTag": { # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ + "recurseTag": { # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ # Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ }, - "regenUidTag": { # Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI # Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI + "regenUidTag": { # Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI # Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI }, "removeTag": { # Replace with empty tag. # Replace with empty tag. }, @@ -249,9 +249,9 @@

Method Details

}, ], "options": { # Specifies additional options to apply to the base profile. # Specifies additional options to apply, overriding the base `profile`. - "cleanDescriptors": { # This option is based on the DICOM Standard's [Clean Descriptors Option](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This option uses an additional infoType during inspection. # Set Clean Descriptors Option. + "cleanDescriptors": { # This option is based on the DICOM Standard's [Clean Descriptors Option](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This option uses an additional infoType during inspection. # Set Clean Descriptors Option. }, - "cleanImage": { # Specifies how to handle de-identification of image pixels. # Apply `Action.clean_image` to [`PixelData`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured. + "cleanImage": { # Specifies how to handle de-identification of image pixels. # Apply `Action.clean_image` to [`PixelData`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured. "additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], @@ -260,7 +260,7 @@

Method Details

], "textRedactionMode": "A String", # Determines how to redact text from image. }, - "primaryIds": "A String", # Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html). + "primaryIds": "A String", # Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html). }, "profileType": "A String", # Base profile type for handling DICOM tags. }, diff --git a/docs/dyn/iam_v1.locations.workforcePools.providers.html b/docs/dyn/iam_v1.locations.workforcePools.providers.html index a3ce0900f4..bc0858b8d1 100644 --- a/docs/dyn/iam_v1.locations.workforcePools.providers.html +++ b/docs/dyn/iam_v1.locations.workforcePools.providers.html @@ -130,7 +130,7 @@

Method Details

{ # A configuration for an external identity provider. "attributeCondition": "A String", # Optional. A [Common Expression Language](https://opensource.google/projects/cel) expression, in plain text, to restrict what otherwise valid authentication credentials issued by the provider should not be accepted. The expression must output a boolean representing whether to allow the federation. The following keywords may be referenced in the expressions: * `assertion`: JSON representing the authentication credential issued by the provider. * `google`: The Google attributes mapped from the assertion in the `attribute_mappings`. `google.profile_photo`, `google.display_name` and `google.posix_username` are not supported. * `attribute`: The custom attributes mapped from the assertion in the `attribute_mappings`. The maximum length of the attribute condition expression is 4096 characters. If unspecified, all valid authentication credentials will be accepted. The following example shows how to only allow credentials with a mapped `google.groups` value of `admins`: ``` "'admins' in google.groups" ``` - "attributeMapping": { # Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters, The key must match the regex "^a-zA-Z0-9._{0,31}$". This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 4KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ``` + "attributeMapping": { # Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters, The key must match the regex "^a-zA-Z0-9._{0,31}$". This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 16 KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ``` "a_key": "A String", }, "description": "A String", # Optional. A description of the provider. Cannot exceed 256 characters. @@ -272,7 +272,7 @@

Method Details

{ # A configuration for an external identity provider. "attributeCondition": "A String", # Optional. A [Common Expression Language](https://opensource.google/projects/cel) expression, in plain text, to restrict what otherwise valid authentication credentials issued by the provider should not be accepted. The expression must output a boolean representing whether to allow the federation. The following keywords may be referenced in the expressions: * `assertion`: JSON representing the authentication credential issued by the provider. * `google`: The Google attributes mapped from the assertion in the `attribute_mappings`. `google.profile_photo`, `google.display_name` and `google.posix_username` are not supported. * `attribute`: The custom attributes mapped from the assertion in the `attribute_mappings`. The maximum length of the attribute condition expression is 4096 characters. If unspecified, all valid authentication credentials will be accepted. The following example shows how to only allow credentials with a mapped `google.groups` value of `admins`: ``` "'admins' in google.groups" ``` - "attributeMapping": { # Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters, The key must match the regex "^a-zA-Z0-9._{0,31}$". This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 4KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ``` + "attributeMapping": { # Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters, The key must match the regex "^a-zA-Z0-9._{0,31}$". This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 16 KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ``` "a_key": "A String", }, "description": "A String", # Optional. A description of the provider. Cannot exceed 256 characters. @@ -356,7 +356,7 @@

Method Details

"workforcePoolProviders": [ # A list of providers. { # A configuration for an external identity provider. "attributeCondition": "A String", # Optional. A [Common Expression Language](https://opensource.google/projects/cel) expression, in plain text, to restrict what otherwise valid authentication credentials issued by the provider should not be accepted. The expression must output a boolean representing whether to allow the federation. The following keywords may be referenced in the expressions: * `assertion`: JSON representing the authentication credential issued by the provider. * `google`: The Google attributes mapped from the assertion in the `attribute_mappings`. `google.profile_photo`, `google.display_name` and `google.posix_username` are not supported. * `attribute`: The custom attributes mapped from the assertion in the `attribute_mappings`. The maximum length of the attribute condition expression is 4096 characters. If unspecified, all valid authentication credentials will be accepted. The following example shows how to only allow credentials with a mapped `google.groups` value of `admins`: ``` "'admins' in google.groups" ``` - "attributeMapping": { # Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters, The key must match the regex "^a-zA-Z0-9._{0,31}$". This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 4KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ``` + "attributeMapping": { # Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters, The key must match the regex "^a-zA-Z0-9._{0,31}$". This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 16 KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ``` "a_key": "A String", }, "description": "A String", # Optional. A description of the provider. Cannot exceed 256 characters. @@ -445,7 +445,7 @@

Method Details

{ # A configuration for an external identity provider. "attributeCondition": "A String", # Optional. A [Common Expression Language](https://opensource.google/projects/cel) expression, in plain text, to restrict what otherwise valid authentication credentials issued by the provider should not be accepted. The expression must output a boolean representing whether to allow the federation. The following keywords may be referenced in the expressions: * `assertion`: JSON representing the authentication credential issued by the provider. * `google`: The Google attributes mapped from the assertion in the `attribute_mappings`. `google.profile_photo`, `google.display_name` and `google.posix_username` are not supported. * `attribute`: The custom attributes mapped from the assertion in the `attribute_mappings`. The maximum length of the attribute condition expression is 4096 characters. If unspecified, all valid authentication credentials will be accepted. The following example shows how to only allow credentials with a mapped `google.groups` value of `admins`: ``` "'admins' in google.groups" ``` - "attributeMapping": { # Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters, The key must match the regex "^a-zA-Z0-9._{0,31}$". This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 4KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ``` + "attributeMapping": { # Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters, The key must match the regex "^a-zA-Z0-9._{0,31}$". This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 16 KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ``` "a_key": "A String", }, "description": "A String", # Optional. A description of the provider. Cannot exceed 256 characters. diff --git a/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.html b/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.html index f9559903e4..084bd8493f 100644 --- a/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.html +++ b/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.html @@ -84,25 +84,25 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted scim tenant until 30 days after deletion.

+

Agentspace only. Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted SCIM tenant until 30 days after deletion.

delete(name, x__xgafv=None)

-

Deletes a WorkforcePoolProviderScimTenant. You can undelete a scim tenant for 30 days. After 30 days, deletion is permanent. You cannot update deleted scim tenants. However, you can view and list them.

+

Agentspace only. Deletes a WorkforcePoolProviderScimTenant. You can undelete a SCIM tenant for 30 days. After 30 days, deletion is permanent. You cannot update deleted SCIM tenants. However, you can view and list them.

get(name, x__xgafv=None)

-

Gets an individual WorkforcePoolProviderScimTenant.

+

Agentspace only. Gets an individual WorkforcePoolProviderScimTenant.

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

-

Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted scim tenants are also listed.

+

Agentspace only. Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted SCIM tenants are also listed.

list_next()

Retrieves the next page of results.

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

-

Updates an existing WorkforcePoolProviderScimTenant.

+

Agentspace only. Updates an existing WorkforcePoolProviderScimTenant.

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

-

Undeletes a WorkforcePoolProviderScimTenant, as long as it was deleted fewer than 30 days ago.

+

Agentspace only. Undeletes a WorkforcePoolProviderScimTenant, that was deleted fewer than 30 days ago.

Method Details

close() @@ -111,26 +111,27 @@

Method Details

create(parent, body=None, workforcePoolProviderScimTenantId=None, x__xgafv=None) -
Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted scim tenant until 30 days after deletion.
+  
Agentspace only. Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted SCIM tenant until 30 days after deletion.
 
 Args:
-  parent: string, Required. The parent to create scim tenant. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}' (required)
+  parent: string, Required. Agentspace only. The parent to create SCIM tenant. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}' (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents a scim tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
-  "baseUri": "A String", # Output only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
-  "claimMapping": { # Optional. Maps BYOID claims to SCIM claims.
+{ # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
+  "baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
+  "claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims.
     "a_key": "A String",
   },
-  "description": "A String", # Optional. The description of the scim tenant. Cannot exceed 256 characters.
-  "displayName": "A String", # Optional. The display name of the scim tenant. Cannot exceed 32 characters.
-  "name": "A String", # Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
-  "purgeTime": "A String", # Output only. The timestamp when the scim tenant is going to be purged.
-  "state": "A String", # Output only. The state of the tenant.
+  "description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters.
+  "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters.
+  "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
+  "purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.
+  "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.
+  "state": "A String", # Output only. Agentspace only. The state of the tenant.
 }
 
-  workforcePoolProviderScimTenantId: string, Required. The ID to use for the scim tenant, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-].
+  workforcePoolProviderScimTenantId: string, Required. Agentspace only. The ID to use for the SCIM tenant, which becomes the final component of the resource name. This value should be 4-32 characters, containing the characters [a-z0-9-].
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -139,25 +140,26 @@ 

Method Details

Returns: An object of the form: - { # Represents a scim tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. - "baseUri": "A String", # Output only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ - "claimMapping": { # Optional. Maps BYOID claims to SCIM claims. + { # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. + "baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ + "claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims. "a_key": "A String", }, - "description": "A String", # Optional. The description of the scim tenant. Cannot exceed 256 characters. - "displayName": "A String", # Optional. The display name of the scim tenant. Cannot exceed 32 characters. - "name": "A String", # Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` - "purgeTime": "A String", # Output only. The timestamp when the scim tenant is going to be purged. - "state": "A String", # Output only. The state of the tenant. + "description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters. + "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters. + "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` + "purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged. + "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent. + "state": "A String", # Output only. Agentspace only. The state of the tenant. }
delete(name, x__xgafv=None) -
Deletes a WorkforcePoolProviderScimTenant. You can undelete a scim tenant for 30 days. After 30 days, deletion is permanent. You cannot update deleted scim tenants. However, you can view and list them.
+  
Agentspace only. Deletes a WorkforcePoolProviderScimTenant. You can undelete a SCIM tenant for 30 days. After 30 days, deletion is permanent. You cannot update deleted SCIM tenants. However, you can view and list them.
 
 Args:
-  name: string, Required. The name of the scim tenant to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}` (required)
+  name: string, Required. Agentspace only. The name of the scim tenant to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -166,25 +168,26 @@ 

Method Details

Returns: An object of the form: - { # Represents a scim tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. - "baseUri": "A String", # Output only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ - "claimMapping": { # Optional. Maps BYOID claims to SCIM claims. + { # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. + "baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ + "claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims. "a_key": "A String", }, - "description": "A String", # Optional. The description of the scim tenant. Cannot exceed 256 characters. - "displayName": "A String", # Optional. The display name of the scim tenant. Cannot exceed 32 characters. - "name": "A String", # Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` - "purgeTime": "A String", # Output only. The timestamp when the scim tenant is going to be purged. - "state": "A String", # Output only. The state of the tenant. + "description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters. + "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters. + "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` + "purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged. + "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent. + "state": "A String", # Output only. Agentspace only. The state of the tenant. }
get(name, x__xgafv=None) -
Gets an individual WorkforcePoolProviderScimTenant.
+  
Agentspace only. Gets an individual WorkforcePoolProviderScimTenant.
 
 Args:
-  name: string, Required. The name of the scim tenant to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}` (required)
+  name: string, Required. Agentspace only. The name of the SCIM tenant to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -193,28 +196,29 @@ 

Method Details

Returns: An object of the form: - { # Represents a scim tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. - "baseUri": "A String", # Output only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ - "claimMapping": { # Optional. Maps BYOID claims to SCIM claims. + { # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. + "baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ + "claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims. "a_key": "A String", }, - "description": "A String", # Optional. The description of the scim tenant. Cannot exceed 256 characters. - "displayName": "A String", # Optional. The display name of the scim tenant. Cannot exceed 32 characters. - "name": "A String", # Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` - "purgeTime": "A String", # Output only. The timestamp when the scim tenant is going to be purged. - "state": "A String", # Output only. The state of the tenant. + "description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters. + "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters. + "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` + "purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged. + "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent. + "state": "A String", # Output only. Agentspace only. The state of the tenant. }
list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None) -
Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted scim tenants are also listed.
+  
Agentspace only. Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted SCIM tenants are also listed.
 
 Args:
-  parent: string, Required. The parent to list scim tenants. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}' (required)
-  pageSize: integer, Optional. The maximum number of scim tenants to return. If unspecified, at most 1 scim tenant will be returned.
-  pageToken: string, Optional. A page token, received from a previous `ListScimTenants` call. Provide this to retrieve the subsequent page.
-  showDeleted: boolean, Optional. Whether to return soft-deleted scim tenants.
+  parent: string, Required. Agentspace only. The parent to list SCIM tenants. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}' (required)
+  pageSize: integer, Optional. Agentspace only. The maximum number of SCIM tenants to return. If unspecified, at most 1 scim tenant will be returned.
+  pageToken: string, Optional. Agentspace only. A page token, received from a previous `ListScimTenants` call. Provide this to retrieve the subsequent page.
+  showDeleted: boolean, Optional. Agentspace only. Whether to return soft-deleted SCIM tenants.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -223,19 +227,20 @@ 

Method Details

Returns: An object of the form: - { # Response message for ListWorkforcePoolProviderScimTenants. - "nextPageToken": "A String", # Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. - "workforcePoolProviderScimTenants": [ # Output only. A list of scim tenants. - { # Represents a scim tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. - "baseUri": "A String", # Output only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ - "claimMapping": { # Optional. Maps BYOID claims to SCIM claims. + { # Agentspace only. Response message for ListWorkforcePoolProviderScimTenants. + "nextPageToken": "A String", # Optional. Agentspace only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "workforcePoolProviderScimTenants": [ # Output only. Agentspace only. A list of SCIM tenants. + { # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. + "baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ + "claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims. "a_key": "A String", }, - "description": "A String", # Optional. The description of the scim tenant. Cannot exceed 256 characters. - "displayName": "A String", # Optional. The display name of the scim tenant. Cannot exceed 32 characters. - "name": "A String", # Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` - "purgeTime": "A String", # Output only. The timestamp when the scim tenant is going to be purged. - "state": "A String", # Output only. The state of the tenant. + "description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters. + "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters. + "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` + "purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged. + "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent. + "state": "A String", # Output only. Agentspace only. The state of the tenant. }, ], }
@@ -257,26 +262,27 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates an existing WorkforcePoolProviderScimTenant.
+  
Agentspace only. Updates an existing WorkforcePoolProviderScimTenant.
 
 Args:
-  name: string, Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` (required)
+  name: string, Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents a scim tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
-  "baseUri": "A String", # Output only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
-  "claimMapping": { # Optional. Maps BYOID claims to SCIM claims.
+{ # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
+  "baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
+  "claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims.
     "a_key": "A String",
   },
-  "description": "A String", # Optional. The description of the scim tenant. Cannot exceed 256 characters.
-  "displayName": "A String", # Optional. The display name of the scim tenant. Cannot exceed 32 characters.
-  "name": "A String", # Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
-  "purgeTime": "A String", # Output only. The timestamp when the scim tenant is going to be purged.
-  "state": "A String", # Output only. The state of the tenant.
+  "description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters.
+  "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters.
+  "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
+  "purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.
+  "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.
+  "state": "A String", # Output only. Agentspace only. The state of the tenant.
 }
 
-  updateMask: string, Optional. The list of fields to update.
+  updateMask: string, Optional. Agentspace only. The list of fields to update.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -285,29 +291,30 @@ 

Method Details

Returns: An object of the form: - { # Represents a scim tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. - "baseUri": "A String", # Output only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ - "claimMapping": { # Optional. Maps BYOID claims to SCIM claims. + { # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. + "baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ + "claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims. "a_key": "A String", }, - "description": "A String", # Optional. The description of the scim tenant. Cannot exceed 256 characters. - "displayName": "A String", # Optional. The display name of the scim tenant. Cannot exceed 32 characters. - "name": "A String", # Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` - "purgeTime": "A String", # Output only. The timestamp when the scim tenant is going to be purged. - "state": "A String", # Output only. The state of the tenant. + "description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters. + "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters. + "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` + "purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged. + "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent. + "state": "A String", # Output only. Agentspace only. The state of the tenant. }
undelete(name, body=None, x__xgafv=None) -
Undeletes a WorkforcePoolProviderScimTenant, as long as it was deleted fewer than 30 days ago.
+  
Agentspace only. Undeletes a WorkforcePoolProviderScimTenant, that was deleted fewer than 30 days ago.
 
 Args:
-  name: string, Required. The name of the scim tenant to undelete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}` (required)
+  name: string, Required. Agentspace only. The name of the SCIM tenant to undelete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}` (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for UndeleteWorkforcePoolProviderScimTenant.
+{ # Agentspace only. Request message for UndeleteWorkforcePoolProviderScimTenant.
 }
 
   x__xgafv: string, V1 error format.
@@ -318,16 +325,17 @@ 

Method Details

Returns: An object of the form: - { # Represents a scim tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. - "baseUri": "A String", # Output only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ - "claimMapping": { # Optional. Maps BYOID claims to SCIM claims. + { # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. + "baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ + "claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims. "a_key": "A String", }, - "description": "A String", # Optional. The description of the scim tenant. Cannot exceed 256 characters. - "displayName": "A String", # Optional. The display name of the scim tenant. Cannot exceed 32 characters. - "name": "A String", # Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` - "purgeTime": "A String", # Output only. The timestamp when the scim tenant is going to be purged. - "state": "A String", # Output only. The state of the tenant. + "description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters. + "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters. + "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` + "purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged. + "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent. + "state": "A String", # Output only. Agentspace only. The state of the tenant. }
diff --git a/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.tokens.html b/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.tokens.html index a8e343235d..182262c87f 100644 --- a/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.tokens.html +++ b/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.tokens.html @@ -79,25 +79,25 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a new WorkforcePoolProviderScimToken in a WorkforcePoolProviderScimTenant. You cannot reuse the name of a deleted SCIM token until 30 days after deletion.

+

Agentspace only. Creates a new WorkforcePoolProviderScimToken in a WorkforcePoolProviderScimTenant. You cannot reuse the name of a deleted SCIM token until 30 days after deletion.

delete(name, x__xgafv=None)

-

Deletes a WorkforcePoolProviderScimToken. You can undelete a scim token for 30 days. After 30 days, deletion is permanent. You cannot update deleted scim tokens. However, you can view and list them.

+

Agentspace only. Deletes a WorkforcePoolProviderScimToken. You can undelete a SCIM token for 30 days. After 30 days, the SCIM token is permanently deleted. You cannot update deleted SCIM tokens, however, you can view and list them.

get(name, x__xgafv=None)

-

Gets an individual WorkforcePoolProviderScimToken.

+

Agentspace only. Gets an individual WorkforcePoolProviderScimToken.

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

-

Lists all non-deleted WorkforcePoolProviderScimTokenss in a WorkforcePoolProviderScimTenant. If `show_deleted` is set to `true`, then deleted SCIM tokens are also listed.

+

Agentspace only. Lists all non-deleted WorkforcePoolProviderScimTokenss in a WorkforcePoolProviderScimTenant. If `show_deleted` is set to `true`, then deleted SCIM tokens are also listed.

list_next()

Retrieves the next page of results.

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

-

Updates an existing WorkforcePoolProviderScimToken.

+

Agentspace only. Updates an existing WorkforcePoolProviderScimToken.

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

-

Undeletes a WorkforcePoolProviderScimToken, as long as it was deleted fewer than 30 days ago.

+

Agentspace only. Undeletes a WorkforcePoolProviderScimToken,that was deleted fewer than 30 days ago.

Method Details

close() @@ -106,21 +106,21 @@

Method Details

create(parent, body=None, workforcePoolProviderScimTokenId=None, x__xgafv=None) -
Creates a new WorkforcePoolProviderScimToken in a WorkforcePoolProviderScimTenant. You cannot reuse the name of a deleted SCIM token until 30 days after deletion.
+  
Agentspace only. Creates a new WorkforcePoolProviderScimToken in a WorkforcePoolProviderScimTenant. You cannot reuse the name of a deleted SCIM token until 30 days after deletion.
 
 Args:
-  parent: string, Required. The parent tenant to create scim token. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}' (required)
+  parent: string, Required. Agentspace only. The parent tenant to create SCIM token. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}' (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests.
-  "displayName": "A String", # Optional. The display name of the scim token. Cannot exceed 32 characters.
-  "name": "A String", # Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
-  "securityToken": "A String", # Output only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
-  "state": "A String", # Output only. The state of the token.
+{ # Agentspace only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests.
+  "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM token. Cannot exceed 32 characters.
+  "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
+  "securityToken": "A String", # Output only. Agentspace only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
+  "state": "A String", # Output only. Agentspace only. The state of the token.
 }
 
-  workforcePoolProviderScimTokenId: string, Required. The ID to use for the scim token, which becomes the final component of the resource name. This value should be 4-32 characters and follow this pattern: "([a-z]([a-z0-9\\-]{2,30}[a-z0-9]))"
+  workforcePoolProviderScimTokenId: string, Required. Agentspace only. The ID to use for the SCIM token, which becomes the final component of the resource name. This value should be 4-32 characters and follow the pattern: "([a-z]([a-z0-9\\-]{2,30}[a-z0-9]))"
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -129,20 +129,20 @@ 

Method Details

Returns: An object of the form: - { # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests. - "displayName": "A String", # Optional. The display name of the scim token. Cannot exceed 32 characters. - "name": "A String", # Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` - "securityToken": "A String", # Output only. The token string. Provide this to the IdP for authentication. Will be set only during creation. - "state": "A String", # Output only. The state of the token. + { # Agentspace only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests. + "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM token. Cannot exceed 32 characters. + "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` + "securityToken": "A String", # Output only. Agentspace only. The token string. Provide this to the IdP for authentication. Will be set only during creation. + "state": "A String", # Output only. Agentspace only. The state of the token. }
delete(name, x__xgafv=None) -
Deletes a WorkforcePoolProviderScimToken. You can undelete a scim token for 30 days. After 30 days, deletion is permanent. You cannot update deleted scim tokens. However, you can view and list them.
+  
Agentspace only. Deletes a WorkforcePoolProviderScimToken. You can undelete a SCIM token for 30 days. After 30 days, the SCIM token is permanently deleted. You cannot update deleted SCIM tokens, however, you can view and list them.
 
 Args:
-  name: string, Required. The name of the scim token to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}` (required)
+  name: string, Required. Agentspace only. The name of the SCIM token to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -151,20 +151,20 @@ 

Method Details

Returns: An object of the form: - { # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests. - "displayName": "A String", # Optional. The display name of the scim token. Cannot exceed 32 characters. - "name": "A String", # Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` - "securityToken": "A String", # Output only. The token string. Provide this to the IdP for authentication. Will be set only during creation. - "state": "A String", # Output only. The state of the token. + { # Agentspace only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests. + "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM token. Cannot exceed 32 characters. + "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` + "securityToken": "A String", # Output only. Agentspace only. The token string. Provide this to the IdP for authentication. Will be set only during creation. + "state": "A String", # Output only. Agentspace only. The state of the token. }
get(name, x__xgafv=None) -
Gets an individual WorkforcePoolProviderScimToken.
+  
Agentspace only. Gets an individual WorkforcePoolProviderScimToken.
 
 Args:
-  name: string, Required. The name of the scim token to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}` (required)
+  name: string, Required. Agentspace only. The name of the SCIM token to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -173,23 +173,23 @@ 

Method Details

Returns: An object of the form: - { # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests. - "displayName": "A String", # Optional. The display name of the scim token. Cannot exceed 32 characters. - "name": "A String", # Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` - "securityToken": "A String", # Output only. The token string. Provide this to the IdP for authentication. Will be set only during creation. - "state": "A String", # Output only. The state of the token. + { # Agentspace only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests. + "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM token. Cannot exceed 32 characters. + "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` + "securityToken": "A String", # Output only. Agentspace only. The token string. Provide this to the IdP for authentication. Will be set only during creation. + "state": "A String", # Output only. Agentspace only. The state of the token. }
list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None) -
Lists all non-deleted WorkforcePoolProviderScimTokenss in a WorkforcePoolProviderScimTenant. If `show_deleted` is set to `true`, then deleted SCIM tokens are also listed.
+  
Agentspace only. Lists all non-deleted WorkforcePoolProviderScimTokenss in a WorkforcePoolProviderScimTenant. If `show_deleted` is set to `true`, then deleted SCIM tokens are also listed.
 
 Args:
-  parent: string, Required. The parent to list scim tokens. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}' (required)
-  pageSize: integer, Optional. The maximum number of scim tokens to return. If unspecified, at most 2 scim tokens will be returned.
-  pageToken: string, Optional. A page token, received from a previous `ListWorkforcePoolProviderScimTokens` call. Provide this to retrieve the subsequent page.
-  showDeleted: boolean, Optional. Whether to return soft-deleted scim tokens.
+  parent: string, Required. Agentspace only. The parent to list SCIM tokens. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}' (required)
+  pageSize: integer, Optional. Agentspace only. The maximum number of scim tokens to return. If unspecified, at most 2 SCIM tokens will be returned.
+  pageToken: string, Optional. Agentspace only. A page token, received from a previous `ListWorkforcePoolProviderScimTokens` call. Provide this to retrieve the subsequent page.
+  showDeleted: boolean, Optional. Agentspace only. Whether to return soft-deleted scim tokens.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -198,14 +198,14 @@ 

Method Details

Returns: An object of the form: - { # Response message for ListWorkforcePoolProviderScimTokens. - "nextPageToken": "A String", # Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. - "workforcePoolProviderScimTokens": [ # Output only. A list of scim tokens. - { # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests. - "displayName": "A String", # Optional. The display name of the scim token. Cannot exceed 32 characters. - "name": "A String", # Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` - "securityToken": "A String", # Output only. The token string. Provide this to the IdP for authentication. Will be set only during creation. - "state": "A String", # Output only. The state of the token. + { # Agentspace only. Response message for ListWorkforcePoolProviderScimTokens. + "nextPageToken": "A String", # Optional. Agentspace only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "workforcePoolProviderScimTokens": [ # Output only. Agentspace only. A list of SCIM tokens. + { # Agentspace only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests. + "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM token. Cannot exceed 32 characters. + "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` + "securityToken": "A String", # Output only. Agentspace only. The token string. Provide this to the IdP for authentication. Will be set only during creation. + "state": "A String", # Output only. Agentspace only. The state of the token. }, ], }
@@ -227,21 +227,21 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates an existing WorkforcePoolProviderScimToken.
+  
Agentspace only. Updates an existing WorkforcePoolProviderScimToken.
 
 Args:
-  name: string, Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` (required)
+  name: string, Identifier. Agentspace only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests.
-  "displayName": "A String", # Optional. The display name of the scim token. Cannot exceed 32 characters.
-  "name": "A String", # Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
-  "securityToken": "A String", # Output only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
-  "state": "A String", # Output only. The state of the token.
+{ # Agentspace only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests.
+  "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM token. Cannot exceed 32 characters.
+  "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
+  "securityToken": "A String", # Output only. Agentspace only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
+  "state": "A String", # Output only. Agentspace only. The state of the token.
 }
 
-  updateMask: string, Optional. The list of fields to update.
+  updateMask: string, Optional. Agentspace only. The list of fields to update.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -250,24 +250,24 @@ 

Method Details

Returns: An object of the form: - { # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests. - "displayName": "A String", # Optional. The display name of the scim token. Cannot exceed 32 characters. - "name": "A String", # Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` - "securityToken": "A String", # Output only. The token string. Provide this to the IdP for authentication. Will be set only during creation. - "state": "A String", # Output only. The state of the token. + { # Agentspace only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests. + "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM token. Cannot exceed 32 characters. + "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` + "securityToken": "A String", # Output only. Agentspace only. The token string. Provide this to the IdP for authentication. Will be set only during creation. + "state": "A String", # Output only. Agentspace only. The state of the token. }
undelete(name, body=None, x__xgafv=None) -
Undeletes a WorkforcePoolProviderScimToken, as long as it was deleted fewer than 30 days ago.
+  
Agentspace only. Undeletes a WorkforcePoolProviderScimToken,that was deleted fewer than 30 days ago.
 
 Args:
-  name: string, Required. The name of the scim token to undelete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}` (required)
+  name: string, Required. Agentspace only. The name of the SCIM token to undelete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}` (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for UndeleteWorkforcePoolProviderScimToken.
+{ # Agentspace only. Request message for UndeleteWorkforcePoolProviderScimToken.
 }
 
   x__xgafv: string, V1 error format.
@@ -278,11 +278,11 @@ 

Method Details

Returns: An object of the form: - { # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests. - "displayName": "A String", # Optional. The display name of the scim token. Cannot exceed 32 characters. - "name": "A String", # Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` - "securityToken": "A String", # Output only. The token string. Provide this to the IdP for authentication. Will be set only during creation. - "state": "A String", # Output only. The state of the token. + { # Agentspace only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests. + "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM token. Cannot exceed 32 characters. + "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` + "securityToken": "A String", # Output only. Agentspace only. The token string. Provide this to the IdP for authentication. Will be set only during creation. + "state": "A String", # Output only. Agentspace only. The state of the token. }
diff --git a/docs/dyn/iam_v1.projects.locations.workloadIdentityPools.namespaces.managedIdentities.html b/docs/dyn/iam_v1.projects.locations.workloadIdentityPools.namespaces.managedIdentities.html index 420a5249e9..ca8ead6d4d 100644 --- a/docs/dyn/iam_v1.projects.locations.workloadIdentityPools.namespaces.managedIdentities.html +++ b/docs/dyn/iam_v1.projects.locations.workloadIdentityPools.namespaces.managedIdentities.html @@ -186,7 +186,7 @@

Method Details

"description": "A String", # Optional. A description of the managed identity. Cannot exceed 256 characters. "disabled": True or False, # Optional. Whether the managed identity is disabled. If disabled, credentials may no longer be issued for the identity, however existing credentials will still be accepted until they expire. "expireTime": "A String", # Output only. Time after which the managed identity will be permanently purged and cannot be recovered. - "name": "A String", # Identifier. The resource name of the managed identity. + "name": "A String", # Output only. The resource name of the managed identity. "state": "A String", # Output only. The state of the managed identity. } @@ -273,7 +273,7 @@

Method Details

"description": "A String", # Optional. A description of the managed identity. Cannot exceed 256 characters. "disabled": True or False, # Optional. Whether the managed identity is disabled. If disabled, credentials may no longer be issued for the identity, however existing credentials will still be accepted until they expire. "expireTime": "A String", # Output only. Time after which the managed identity will be permanently purged and cannot be recovered. - "name": "A String", # Identifier. The resource name of the managed identity. + "name": "A String", # Output only. The resource name of the managed identity. "state": "A String", # Output only. The state of the managed identity. }
@@ -302,7 +302,7 @@

Method Details

"description": "A String", # Optional. A description of the managed identity. Cannot exceed 256 characters. "disabled": True or False, # Optional. Whether the managed identity is disabled. If disabled, credentials may no longer be issued for the identity, however existing credentials will still be accepted until they expire. "expireTime": "A String", # Output only. Time after which the managed identity will be permanently purged and cannot be recovered. - "name": "A String", # Identifier. The resource name of the managed identity. + "name": "A String", # Output only. The resource name of the managed identity. "state": "A String", # Output only. The state of the managed identity. }, ], @@ -369,7 +369,7 @@

Method Details

Updates an existing WorkloadIdentityPoolManagedIdentity in a WorkloadIdentityPoolNamespace.
 
 Args:
-  name: string, Identifier. The resource name of the managed identity. (required)
+  name: string, Output only. The resource name of the managed identity. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -377,7 +377,7 @@ 

Method Details

"description": "A String", # Optional. A description of the managed identity. Cannot exceed 256 characters. "disabled": True or False, # Optional. Whether the managed identity is disabled. If disabled, credentials may no longer be issued for the identity, however existing credentials will still be accepted until they expire. "expireTime": "A String", # Output only. Time after which the managed identity will be permanently purged and cannot be recovered. - "name": "A String", # Identifier. The resource name of the managed identity. + "name": "A String", # Output only. The resource name of the managed identity. "state": "A String", # Output only. The state of the managed identity. } diff --git a/docs/dyn/iam_v1.projects.locations.workloadIdentityPools.providers.html b/docs/dyn/iam_v1.projects.locations.workloadIdentityPools.providers.html index 8ad1f90fcc..f6a8bd142d 100644 --- a/docs/dyn/iam_v1.projects.locations.workloadIdentityPools.providers.html +++ b/docs/dyn/iam_v1.projects.locations.workloadIdentityPools.providers.html @@ -135,7 +135,7 @@

Method Details

"disabled": True or False, # Optional. Whether the provider is disabled. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access. "displayName": "A String", # Optional. A display name for the provider. Cannot exceed 32 characters. "expireTime": "A String", # Output only. Time after which the workload identity pool provider will be permanently purged and cannot be recovered. - "name": "A String", # Identifier. The resource name of the provider. + "name": "A String", # Output only. The resource name of the provider. "oidc": { # Represents an OpenId Connect 1.0 identity provider. # An OpenId Connect 1.0 identity provider. "allowedAudiences": [ # Optional. Acceptable values for the `aud` field (audience) in the OIDC token. Token exchange requests are rejected if the token audience does not match one of the configured values. Each audience may be at most 256 characters. A maximum of 10 audiences may be configured. If this list is empty, the OIDC token audience must be equal to the full canonical resource name of the WorkloadIdentityPoolProvider, with or without the HTTPS prefix. For example: ``` //iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ https://iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ ``` "A String", @@ -254,7 +254,7 @@

Method Details

"disabled": True or False, # Optional. Whether the provider is disabled. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access. "displayName": "A String", # Optional. A display name for the provider. Cannot exceed 32 characters. "expireTime": "A String", # Output only. Time after which the workload identity pool provider will be permanently purged and cannot be recovered. - "name": "A String", # Identifier. The resource name of the provider. + "name": "A String", # Output only. The resource name of the provider. "oidc": { # Represents an OpenId Connect 1.0 identity provider. # An OpenId Connect 1.0 identity provider. "allowedAudiences": [ # Optional. Acceptable values for the `aud` field (audience) in the OIDC token. Token exchange requests are rejected if the token audience does not match one of the configured values. Each audience may be at most 256 characters. A maximum of 10 audiences may be configured. If this list is empty, the OIDC token audience must be equal to the full canonical resource name of the WorkloadIdentityPoolProvider, with or without the HTTPS prefix. For example: ``` //iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ https://iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ ``` "A String", @@ -315,7 +315,7 @@

Method Details

"disabled": True or False, # Optional. Whether the provider is disabled. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access. "displayName": "A String", # Optional. A display name for the provider. Cannot exceed 32 characters. "expireTime": "A String", # Output only. Time after which the workload identity pool provider will be permanently purged and cannot be recovered. - "name": "A String", # Identifier. The resource name of the provider. + "name": "A String", # Output only. The resource name of the provider. "oidc": { # Represents an OpenId Connect 1.0 identity provider. # An OpenId Connect 1.0 identity provider. "allowedAudiences": [ # Optional. Acceptable values for the `aud` field (audience) in the OIDC token. Token exchange requests are rejected if the token audience does not match one of the configured values. Each audience may be at most 256 characters. A maximum of 10 audiences may be configured. If this list is empty, the OIDC token audience must be equal to the full canonical resource name of the WorkloadIdentityPoolProvider, with or without the HTTPS prefix. For example: ``` //iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ https://iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ ``` "A String", @@ -365,7 +365,7 @@

Method Details

Updates an existing WorkloadIdentityPoolProvider.
 
 Args:
-  name: string, Identifier. The resource name of the provider. (required)
+  name: string, Output only. The resource name of the provider. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -381,7 +381,7 @@ 

Method Details

"disabled": True or False, # Optional. Whether the provider is disabled. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access. "displayName": "A String", # Optional. A display name for the provider. Cannot exceed 32 characters. "expireTime": "A String", # Output only. Time after which the workload identity pool provider will be permanently purged and cannot be recovered. - "name": "A String", # Identifier. The resource name of the provider. + "name": "A String", # Output only. The resource name of the provider. "oidc": { # Represents an OpenId Connect 1.0 identity provider. # An OpenId Connect 1.0 identity provider. "allowedAudiences": [ # Optional. Acceptable values for the `aud` field (audience) in the OIDC token. Token exchange requests are rejected if the token audience does not match one of the configured values. Each audience may be at most 256 characters. A maximum of 10 audiences may be configured. If this list is empty, the OIDC token audience must be equal to the full canonical resource name of the WorkloadIdentityPoolProvider, with or without the HTTPS prefix. For example: ``` //iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ https://iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ ``` "A String", diff --git a/docs/dyn/metastore_v1.projects.locations.operations.html b/docs/dyn/metastore_v1.projects.locations.operations.html index 392b347f69..b9b5760d1e 100644 --- a/docs/dyn/metastore_v1.projects.locations.operations.html +++ b/docs/dyn/metastore_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/metastore_v1alpha.projects.locations.operations.html b/docs/dyn/metastore_v1alpha.projects.locations.operations.html index 3f4c68b64f..ccab643b9e 100644 --- a/docs/dyn/metastore_v1alpha.projects.locations.operations.html +++ b/docs/dyn/metastore_v1alpha.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/metastore_v1beta.projects.locations.operations.html b/docs/dyn/metastore_v1beta.projects.locations.operations.html index 978c014035..374e2b03e8 100644 --- a/docs/dyn/metastore_v1beta.projects.locations.operations.html +++ b/docs/dyn/metastore_v1beta.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/migrationcenter_v1.projects.locations.groups.html b/docs/dyn/migrationcenter_v1.projects.locations.groups.html index a94add8c49..ecf32584f2 100644 --- a/docs/dyn/migrationcenter_v1.projects.locations.groups.html +++ b/docs/dyn/migrationcenter_v1.projects.locations.groups.html @@ -113,7 +113,7 @@

Method Details

{ # A request to add assets to a group. "allowExisting": True or False, # Optional. When this value is set to `false` and one of the given assets is already an existing member of the group, the operation fails with an `Already Exists` error. When set to `true` this situation is silently ignored by the server. Default value is `false`. - "assets": { # Lists the asset IDs of all assets. # Required. List of assets to be added. The maximum number of assets that can be added in a single request is 1000. + "assets": { # Lists the asset IDs of all assets. # Required. List of assets to be added. The maximum number of assets that can be added in a single request is 2000. "assetIds": [ # Required. A list of asset IDs "A String", ], diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.groups.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.groups.html index 063f1e6fb6..1fe5ccf4e0 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.groups.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.groups.html @@ -113,7 +113,7 @@

Method Details

{ # A request to add assets to a group. "allowExisting": True or False, # Optional. When this value is set to `false` and one of the given assets is already an existing member of the group, the operation fails with an `Already Exists` error. When set to `true` this situation is silently ignored by the server. Default value is `false`. - "assets": { # Lists the asset IDs of all assets. # Required. List of assets to be added. The maximum number of assets that can be added in a single request is 1000. + "assets": { # Lists the asset IDs of all assets. # Required. List of assets to be added. The maximum number of assets that can be added in a single request is 2000. "assetIds": [ # Required. A list of asset IDs "A String", ], diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.operations.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.operations.html index 129d7d574c..04f227e270 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.operations.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.html b/docs/dyn/networkconnectivity_v1.projects.locations.html index 7f18e012bf..c27c349537 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.html @@ -139,6 +139,9 @@

Instance Methods

Returns the transports Resource.

+

+ checkConsumerConfig(location, body=None, x__xgafv=None)

+

CheckConsumerConfig validates the consumer network and project for potential PSC connection creation. This method performs several checks, including: - Validating the existence and permissions of the service class. - Ensuring the consumer network exists and is accessible. - Verifying XPN relationships if applicable. - Checking for compatible IP versions between the consumer network and the requested version. This method performs a dynamic IAM check for the `networkconnectivity.serviceClasses.use` permission on the service class resource in the Prepare phase.

close()

Close httplib2 connections.

@@ -152,6 +155,37 @@

Instance Methods

list_next()

Retrieves the next page of results.

Method Details

+
+ checkConsumerConfig(location, body=None, x__xgafv=None) +
CheckConsumerConfig validates the consumer network and project for potential PSC connection creation. This method performs several checks, including: - Validating the existence and permissions of the service class. - Ensuring the consumer network exists and is accessible. - Verifying XPN relationships if applicable. - Checking for compatible IP versions between the consumer network and the requested version. This method performs a dynamic IAM check for the `networkconnectivity.serviceClasses.use` permission on the service class resource in the Prepare phase.
+
+Args:
+  location: string, Required. The location resource path. Example: - projects/{project}/locations/{location} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for CheckConsumerConfig.
+  "consumerNetwork": "A String", # Required. Full resource name of the consumer network. Example: - projects/{project}/global/networks/{network}.
+  "endpointProject": "A String", # The project number or ID where the PSC endpoint is to be created.
+  "requestedIpVersion": "A String", # The requested IP Version
+  "serviceClass": "A String", # Required. The service class identifier of the producer.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for CheckConsumerConfig.
+  "errors": [ # List of validation errors. If the list is empty, the consumer config is valid.
+    "A String",
+  ],
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.operations.html b/docs/dyn/networkconnectivity_v1.projects.locations.operations.html index 1bdcada47e..d03a2f658d 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.operations.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.regionalEndpoints.html b/docs/dyn/networkconnectivity_v1.projects.locations.regionalEndpoints.html index c4ea4030a1..7e41c8f4b5 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.regionalEndpoints.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.regionalEndpoints.html @@ -117,9 +117,9 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. The name of a RegionalEndpoint. Pattern: `projects/{project}/locations/{location}/regionalEndpoints/^[-a-z0-9](?:[-a-z0-9]{0,44})[a-z0-9]$`. - "network": "A String", # The name of the VPC network for this private regional endpoint. Format: `projects/{project}/global/networks/{network}` + "network": "A String", # Optional. The name of the VPC network for this private regional endpoint. Format: `projects/{project}/global/networks/{network}` "pscForwardingRule": "A String", # Output only. The resource reference of the PSC Forwarding Rule created on behalf of the customer. Format: `//compute.googleapis.com/projects/{project}/regions/{region}/forwardingRules/{forwarding_rule_name}` - "subnetwork": "A String", # The name of the subnetwork from which the IP address will be allocated. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` + "subnetwork": "A String", # Optional. The name of the subnetwork from which the IP address will be allocated. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` "targetGoogleApi": "A String", # Required. The service endpoint this private regional endpoint connects to. Format: `{apiname}.{region}.p.rep.googleapis.com` Example: "cloudkms.us-central1.p.rep.googleapis.com". "updateTime": "A String", # Output only. Time when the RegionalEndpoint was updated. } @@ -215,9 +215,9 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. The name of a RegionalEndpoint. Pattern: `projects/{project}/locations/{location}/regionalEndpoints/^[-a-z0-9](?:[-a-z0-9]{0,44})[a-z0-9]$`. - "network": "A String", # The name of the VPC network for this private regional endpoint. Format: `projects/{project}/global/networks/{network}` + "network": "A String", # Optional. The name of the VPC network for this private regional endpoint. Format: `projects/{project}/global/networks/{network}` "pscForwardingRule": "A String", # Output only. The resource reference of the PSC Forwarding Rule created on behalf of the customer. Format: `//compute.googleapis.com/projects/{project}/regions/{region}/forwardingRules/{forwarding_rule_name}` - "subnetwork": "A String", # The name of the subnetwork from which the IP address will be allocated. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` + "subnetwork": "A String", # Optional. The name of the subnetwork from which the IP address will be allocated. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` "targetGoogleApi": "A String", # Required. The service endpoint this private regional endpoint connects to. Format: `{apiname}.{region}.p.rep.googleapis.com` Example: "cloudkms.us-central1.p.rep.googleapis.com". "updateTime": "A String", # Output only. Time when the RegionalEndpoint was updated. }
@@ -254,9 +254,9 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. The name of a RegionalEndpoint. Pattern: `projects/{project}/locations/{location}/regionalEndpoints/^[-a-z0-9](?:[-a-z0-9]{0,44})[a-z0-9]$`. - "network": "A String", # The name of the VPC network for this private regional endpoint. Format: `projects/{project}/global/networks/{network}` + "network": "A String", # Optional. The name of the VPC network for this private regional endpoint. Format: `projects/{project}/global/networks/{network}` "pscForwardingRule": "A String", # Output only. The resource reference of the PSC Forwarding Rule created on behalf of the customer. Format: `//compute.googleapis.com/projects/{project}/regions/{region}/forwardingRules/{forwarding_rule_name}` - "subnetwork": "A String", # The name of the subnetwork from which the IP address will be allocated. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` + "subnetwork": "A String", # Optional. The name of the subnetwork from which the IP address will be allocated. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` "targetGoogleApi": "A String", # Required. The service endpoint this private regional endpoint connects to. Format: `{apiname}.{region}.p.rep.googleapis.com` Example: "cloudkms.us-central1.p.rep.googleapis.com". "updateTime": "A String", # Output only. Time when the RegionalEndpoint was updated. }, diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.transports.html b/docs/dyn/networkconnectivity_v1.projects.locations.transports.html index 28787174ef..b195f98910 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.transports.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.transports.html @@ -112,7 +112,9 @@

Method Details

{ # Message describing Transport object. "adminEnabled": True or False, # Optional. Administrative state of the underlying connectivity. If set to true (default), connectivity should be available between your environments. If set to false, the connectivity over these links is disabled. Disabling your Transport does not affect billing, and retains the underlying network bandwidth associated with the connectivity. - "advertisedRoutes": "A String", # Optional. [Preview only] List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported. + "advertisedRoutes": [ # Optional. [Preview only] List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported. + "A String", + ], "bandwidth": "A String", # Required. Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile. "createTime": "A String", # Output only. [Output only] Create time stamp. "description": "A String", # Optional. Description of the Transport. @@ -214,7 +216,9 @@

Method Details

{ # Message describing Transport object. "adminEnabled": True or False, # Optional. Administrative state of the underlying connectivity. If set to true (default), connectivity should be available between your environments. If set to false, the connectivity over these links is disabled. Disabling your Transport does not affect billing, and retains the underlying network bandwidth associated with the connectivity. - "advertisedRoutes": "A String", # Optional. [Preview only] List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported. + "advertisedRoutes": [ # Optional. [Preview only] List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported. + "A String", + ], "bandwidth": "A String", # Required. Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile. "createTime": "A String", # Output only. [Output only] Create time stamp. "description": "A String", # Optional. Description of the Transport. @@ -257,7 +261,9 @@

Method Details

"transports": [ # The list of Transport. { # Message describing Transport object. "adminEnabled": True or False, # Optional. Administrative state of the underlying connectivity. If set to true (default), connectivity should be available between your environments. If set to false, the connectivity over these links is disabled. Disabling your Transport does not affect billing, and retains the underlying network bandwidth associated with the connectivity. - "advertisedRoutes": "A String", # Optional. [Preview only] List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported. + "advertisedRoutes": [ # Optional. [Preview only] List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported. + "A String", + ], "bandwidth": "A String", # Required. Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile. "createTime": "A String", # Output only. [Output only] Create time stamp. "description": "A String", # Optional. Description of the Transport. @@ -307,7 +313,9 @@

Method Details

{ # Message describing Transport object. "adminEnabled": True or False, # Optional. Administrative state of the underlying connectivity. If set to true (default), connectivity should be available between your environments. If set to false, the connectivity over these links is disabled. Disabling your Transport does not affect billing, and retains the underlying network bandwidth associated with the connectivity. - "advertisedRoutes": "A String", # Optional. [Preview only] List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported. + "advertisedRoutes": [ # Optional. [Preview only] List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported. + "A String", + ], "bandwidth": "A String", # Required. Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile. "createTime": "A String", # Output only. [Output only] Create time stamp. "description": "A String", # Optional. Description of the Transport. diff --git a/docs/dyn/networkconnectivity_v1alpha1.projects.locations.operations.html b/docs/dyn/networkconnectivity_v1alpha1.projects.locations.operations.html index ec506879b8..ce4d31a76b 100644 --- a/docs/dyn/networkconnectivity_v1alpha1.projects.locations.operations.html +++ b/docs/dyn/networkconnectivity_v1alpha1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/networkmanagement_v1.organizations.locations.operations.html b/docs/dyn/networkmanagement_v1.organizations.locations.operations.html index 5159a3de43..f60eb0ca79 100644 --- a/docs/dyn/networkmanagement_v1.organizations.locations.operations.html +++ b/docs/dyn/networkmanagement_v1.organizations.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/networkmanagement_v1.projects.locations.global_.operations.html b/docs/dyn/networkmanagement_v1.projects.locations.global_.operations.html index a304c9ae21..a558e7fc85 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.global_.operations.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.global_.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/networkmanagement_v1.projects.locations.html b/docs/dyn/networkmanagement_v1.projects.locations.html index 880f56bb11..219f23e68b 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.html @@ -79,11 +79,6 @@

Instance Methods

Returns the global_ Resource.

-

- networkMonitoringProviders() -

-

Returns the networkMonitoringProviders Resource.

-

vpcFlowLogsConfigs()

diff --git a/docs/dyn/networkmanagement_v1beta1.organizations.locations.global_.operations.html b/docs/dyn/networkmanagement_v1beta1.organizations.locations.global_.operations.html index 96182fc674..bf5cf9cf51 100644 --- a/docs/dyn/networkmanagement_v1beta1.organizations.locations.global_.operations.html +++ b/docs/dyn/networkmanagement_v1beta1.organizations.locations.global_.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.operations.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.operations.html index c180f8434a..414b67c632 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.operations.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/networksecurity_v1.organizations.locations.operations.html b/docs/dyn/networksecurity_v1.organizations.locations.operations.html index 565e54b9b5..921b32c987 100644 --- a/docs/dyn/networksecurity_v1.organizations.locations.operations.html +++ b/docs/dyn/networksecurity_v1.organizations.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html b/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html index 94747d1614..3e0b1f0c9e 100644 --- a/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html +++ b/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html @@ -300,8 +300,8 @@

Method Details

}, "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. - "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `INTERNAL_SELF_MANAGED`, and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied. For policies created for Cloudrun, this field will reference the Cloud Run services. + "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied. "A String", ], }, @@ -570,8 +570,8 @@

Method Details

}, "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. - "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `INTERNAL_SELF_MANAGED`, and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied. For policies created for Cloudrun, this field will reference the Cloud Run services. + "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied. "A String", ], }, @@ -828,8 +828,8 @@

Method Details

}, "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. - "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `INTERNAL_SELF_MANAGED`, and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied. For policies created for Cloudrun, this field will reference the Cloud Run services. + "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied. "A String", ], }, @@ -1047,8 +1047,8 @@

Method Details

}, "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. - "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `INTERNAL_SELF_MANAGED`, and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied. For policies created for Cloudrun, this field will reference the Cloud Run services. + "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied. "A String", ], }, diff --git a/docs/dyn/networksecurity_v1.projects.locations.operations.html b/docs/dyn/networksecurity_v1.projects.locations.operations.html index 382e02cc92..21bf61ba6d 100644 --- a/docs/dyn/networksecurity_v1.projects.locations.operations.html +++ b/docs/dyn/networksecurity_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/networksecurity_v1beta1.organizations.locations.operations.html b/docs/dyn/networksecurity_v1beta1.organizations.locations.operations.html index abf9c6524f..37893b0316 100644 --- a/docs/dyn/networksecurity_v1beta1.organizations.locations.operations.html +++ b/docs/dyn/networksecurity_v1beta1.organizations.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html b/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html index 8eea6d4ea1..58405a291d 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html @@ -300,8 +300,8 @@

Method Details

}, "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. - "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `INTERNAL_SELF_MANAGED`, and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied. For policies created for Cloudrun, this field will reference the Cloud Run services. + "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied. "A String", ], }, @@ -570,8 +570,8 @@

Method Details

}, "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. - "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `INTERNAL_SELF_MANAGED`, and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied. For policies created for Cloudrun, this field will reference the Cloud Run services. + "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied. "A String", ], }, @@ -828,8 +828,8 @@

Method Details

}, "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. - "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `INTERNAL_SELF_MANAGED`, and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied. For policies created for Cloudrun, this field will reference the Cloud Run services. + "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied. "A String", ], }, @@ -1047,8 +1047,8 @@

Method Details

}, "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. - "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `INTERNAL_SELF_MANAGED`, and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied. For policies created for Cloudrun, this field will reference the Cloud Run services. + "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied. "A String", ], }, diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.operations.html b/docs/dyn/networksecurity_v1beta1.projects.locations.operations.html index 4e7d20578f..a78838b126 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.operations.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/observability_v1.projects.locations.operations.html b/docs/dyn/observability_v1.projects.locations.operations.html index 87ee5582b4..ba08cb7079 100644 --- a/docs/dyn/observability_v1.projects.locations.operations.html +++ b/docs/dyn/observability_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/ondemandscanning_v1.projects.locations.operations.html b/docs/dyn/ondemandscanning_v1.projects.locations.operations.html index 2d826a6d60..7604288009 100644 --- a/docs/dyn/ondemandscanning_v1.projects.locations.operations.html +++ b/docs/dyn/ondemandscanning_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/ondemandscanning_v1beta1.projects.locations.operations.html b/docs/dyn/ondemandscanning_v1beta1.projects.locations.operations.html index 6a72cbae4e..8d6c163b41 100644 --- a/docs/dyn/ondemandscanning_v1beta1.projects.locations.operations.html +++ b/docs/dyn/ondemandscanning_v1beta1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -173,7 +173,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -212,6 +213,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/osconfig_v2.folders.locations.operations.html b/docs/dyn/osconfig_v2.folders.locations.operations.html index 16a3bd927a..8ff9fd635c 100644 --- a/docs/dyn/osconfig_v2.folders.locations.operations.html +++ b/docs/dyn/osconfig_v2.folders.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/osconfig_v2.organizations.locations.operations.html b/docs/dyn/osconfig_v2.organizations.locations.operations.html index 146bc01607..7d1198b5e0 100644 --- a/docs/dyn/osconfig_v2.organizations.locations.operations.html +++ b/docs/dyn/osconfig_v2.organizations.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/osconfig_v2.projects.locations.operations.html b/docs/dyn/osconfig_v2.projects.locations.operations.html index cc51f0f8a0..e64f6462be 100644 --- a/docs/dyn/osconfig_v2.projects.locations.operations.html +++ b/docs/dyn/osconfig_v2.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/osconfig_v2beta.folders.locations.operations.html b/docs/dyn/osconfig_v2beta.folders.locations.operations.html index 084a8fe475..5559cfe2aa 100644 --- a/docs/dyn/osconfig_v2beta.folders.locations.operations.html +++ b/docs/dyn/osconfig_v2beta.folders.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/osconfig_v2beta.organizations.locations.operations.html b/docs/dyn/osconfig_v2beta.organizations.locations.operations.html index 1b0433247d..a49c215635 100644 --- a/docs/dyn/osconfig_v2beta.organizations.locations.operations.html +++ b/docs/dyn/osconfig_v2beta.organizations.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/osconfig_v2beta.projects.locations.operations.html b/docs/dyn/osconfig_v2beta.projects.locations.operations.html index dfdce75248..aafa8b94d2 100644 --- a/docs/dyn/osconfig_v2beta.projects.locations.operations.html +++ b/docs/dyn/osconfig_v2beta.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/parallelstore_v1.projects.locations.operations.html b/docs/dyn/parallelstore_v1.projects.locations.operations.html index 536ba386ef..33b6ca43b9 100644 --- a/docs/dyn/parallelstore_v1.projects.locations.operations.html +++ b/docs/dyn/parallelstore_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/parallelstore_v1beta.projects.locations.operations.html b/docs/dyn/parallelstore_v1beta.projects.locations.operations.html index 2af13d18fa..6cdc4dce7d 100644 --- a/docs/dyn/parallelstore_v1beta.projects.locations.operations.html +++ b/docs/dyn/parallelstore_v1beta.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -170,7 +170,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -178,6 +178,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -209,6 +210,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/privateca_v1.projects.locations.operations.html b/docs/dyn/privateca_v1.projects.locations.operations.html index 8ec9174eb7..ce03e090ef 100644 --- a/docs/dyn/privateca_v1.projects.locations.operations.html +++ b/docs/dyn/privateca_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/privateca_v1beta1.projects.locations.operations.html b/docs/dyn/privateca_v1beta1.projects.locations.operations.html index 6e3c85c1cc..5f957ab982 100644 --- a/docs/dyn/privateca_v1beta1.projects.locations.operations.html +++ b/docs/dyn/privateca_v1beta1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html index 4078b82b24..d1e87c349c 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html @@ -333,7 +333,7 @@

Method Details

"reencryptedUserCredentialsHash": "A String", # Output only. Corresponds to the re-encryption of the `encrypted_user_credentials_hash` field. It is used to match potential password leaks within `encrypted_leak_match_prefixes`. }, "riskAnalysis": { # Risk analysis result for an event. # Output only. The risk analysis result for the event being assessed. - "challenge": "A String", # Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE keys + "challenge": "A String", # Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE keys. "extendedVerdictReasons": [ # Output only. Extended verdict reasons to be used for experimentation only. The set of possible reasons is subject to change. "A String", ], @@ -562,7 +562,7 @@

Method Details

"reencryptedUserCredentialsHash": "A String", # Output only. Corresponds to the re-encryption of the `encrypted_user_credentials_hash` field. It is used to match potential password leaks within `encrypted_leak_match_prefixes`. }, "riskAnalysis": { # Risk analysis result for an event. # Output only. The risk analysis result for the event being assessed. - "challenge": "A String", # Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE keys + "challenge": "A String", # Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE keys. "extendedVerdictReasons": [ # Output only. Extended verdict reasons to be used for experimentation only. The set of possible reasons is subject to change. "A String", ], diff --git a/docs/dyn/redis_v1.projects.locations.clusters.html b/docs/dyn/redis_v1.projects.locations.clusters.html index 77ddc2b1d2..09526de177 100644 --- a/docs/dyn/redis_v1.projects.locations.clusters.html +++ b/docs/dyn/redis_v1.projects.locations.clusters.html @@ -281,6 +281,7 @@

Method Details

"endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. }, + "maintenanceVersion": "A String", # Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field. "managedBackupSource": { # Backups that generated and managed by memorystore. # Optional. Backups generated and managed by memorystore service. "backup": "A String", # Optional. Example: //redis.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} A shorter version (without the prefix) of the backup name is also supported, like projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup_id} In this case, it assumes the backup is under redis.googleapis.com. }, @@ -547,6 +548,7 @@

Method Details

"endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. }, + "maintenanceVersion": "A String", # Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field. "managedBackupSource": { # Backups that generated and managed by memorystore. # Optional. Backups generated and managed by memorystore service. "backup": "A String", # Optional. Example: //redis.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} A shorter version (without the prefix) of the backup name is also supported, like projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup_id} In this case, it assumes the backup is under redis.googleapis.com. }, @@ -779,6 +781,7 @@

Method Details

"endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. }, + "maintenanceVersion": "A String", # Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field. "managedBackupSource": { # Backups that generated and managed by memorystore. # Optional. Backups generated and managed by memorystore service. "backup": "A String", # Optional. Example: //redis.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} A shorter version (without the prefix) of the backup name is also supported, like projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup_id} In this case, it assumes the backup is under redis.googleapis.com. }, @@ -994,6 +997,7 @@

Method Details

"endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. }, + "maintenanceVersion": "A String", # Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field. "managedBackupSource": { # Backups that generated and managed by memorystore. # Optional. Backups generated and managed by memorystore service. "backup": "A String", # Optional. Example: //redis.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} A shorter version (without the prefix) of the backup name is also supported, like projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup_id} In this case, it assumes the backup is under redis.googleapis.com. }, diff --git a/docs/dyn/redis_v1beta1.projects.locations.clusters.html b/docs/dyn/redis_v1beta1.projects.locations.clusters.html index 41accd1400..6cf52455bf 100644 --- a/docs/dyn/redis_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/redis_v1beta1.projects.locations.clusters.html @@ -281,6 +281,7 @@

Method Details

"endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. }, + "maintenanceVersion": "A String", # Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field. "managedBackupSource": { # Backups that generated and managed by memorystore. # Optional. Backups generated and managed by memorystore service. "backup": "A String", # Optional. Example: //redis.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} A shorter version (without the prefix) of the backup name is also supported, like projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup_id} In this case, it assumes the backup is under redis.googleapis.com. }, @@ -547,6 +548,7 @@

Method Details

"endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. }, + "maintenanceVersion": "A String", # Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field. "managedBackupSource": { # Backups that generated and managed by memorystore. # Optional. Backups generated and managed by memorystore service. "backup": "A String", # Optional. Example: //redis.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} A shorter version (without the prefix) of the backup name is also supported, like projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup_id} In this case, it assumes the backup is under redis.googleapis.com. }, @@ -779,6 +781,7 @@

Method Details

"endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. }, + "maintenanceVersion": "A String", # Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field. "managedBackupSource": { # Backups that generated and managed by memorystore. # Optional. Backups generated and managed by memorystore service. "backup": "A String", # Optional. Example: //redis.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} A shorter version (without the prefix) of the backup name is also supported, like projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup_id} In this case, it assumes the backup is under redis.googleapis.com. }, @@ -994,6 +997,7 @@

Method Details

"endTime": "A String", # Output only. The end time of any upcoming scheduled maintenance for this instance. "startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance. }, + "maintenanceVersion": "A String", # Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field. "managedBackupSource": { # Backups that generated and managed by memorystore. # Optional. Backups generated and managed by memorystore service. "backup": "A String", # Optional. Example: //redis.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} A shorter version (without the prefix) of the backup name is also supported, like projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup_id} In this case, it assumes the backup is under redis.googleapis.com. }, diff --git a/docs/dyn/run_v1.projects.locations.operations.html b/docs/dyn/run_v1.projects.locations.operations.html index f3f82e486f..b5bb955f5e 100644 --- a/docs/dyn/run_v1.projects.locations.operations.html +++ b/docs/dyn/run_v1.projects.locations.operations.html @@ -84,7 +84,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -152,7 +152,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -160,6 +160,7 @@ 

Method Details

filter: string, Optional. A filter for matching the completed or in-progress operations. The supported formats of *filter* are: To query for only completed operations: done:true To query for only ongoing operations: done:false Must be empty to query for all of the latest operations for the given parent project. pageSize: integer, The maximum number of records that should be returned. Requested page size cannot exceed 100. If not set or set to less than or equal to 0, the default page size is 100. . pageToken: string, Token identifying which result to start with, which is returned by a previous list call. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -191,6 +192,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/run_v2.projects.locations.builds.html b/docs/dyn/run_v2.projects.locations.builds.html index 0ca44d77d1..7a8f4dbad3 100644 --- a/docs/dyn/run_v2.projects.locations.builds.html +++ b/docs/dyn/run_v2.projects.locations.builds.html @@ -107,6 +107,7 @@

Method Details

"projectDescriptor": "A String", # Optional. project_descriptor stores the path to the project descriptor file. When empty, it means that there is no project descriptor file in the source. "runtime": "A String", # The runtime name, e.g. 'go113'. Leave blank for generic builds. }, + "client": "A String", # Optional. The client that initiated the build request. "dockerBuild": { # Build the source using Docker. This means the source has a Dockerfile. # Build the source using Docker. This means the source has a Dockerfile. }, "imageUri": "A String", # Required. Artifact Registry URI to store the built image. diff --git a/docs/dyn/run_v2.projects.locations.operations.html b/docs/dyn/run_v2.projects.locations.operations.html index c53fb5355d..0a3d60d307 100644 --- a/docs/dyn/run_v2.projects.locations.operations.html +++ b/docs/dyn/run_v2.projects.locations.operations.html @@ -84,7 +84,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -152,7 +152,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -160,6 +160,7 @@ 

Method Details

filter: string, Optional. A filter for matching the completed or in-progress operations. The supported formats of *filter* are: To query for only completed operations: done:true To query for only ongoing operations: done:false Must be empty to query for all of the latest operations for the given parent project. pageSize: integer, The maximum number of records that should be returned. Requested page size cannot exceed 100. If not set or set to less than or equal to 0, the default page size is 100. . pageToken: string, Token identifying which result to start with, which is returned by a previous list call. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -191,6 +192,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/run_v2.projects.locations.services.html b/docs/dyn/run_v2.projects.locations.services.html index 3912e0da70..57412785f0 100644 --- a/docs/dyn/run_v2.projects.locations.services.html +++ b/docs/dyn/run_v2.projects.locations.services.html @@ -187,7 +187,7 @@

Method Details

"A String", ], }, - "name": "A String", # The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id} + "name": "A String", # Identifier. The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id} "observedGeneration": "A String", # Output only. The generation of this Service currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. "reconciling": True or False, # Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state. When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revision`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Service, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in `terminal_condition` and `conditions`. "satisfiesPzs": True or False, # Output only. Reserved for future use. @@ -556,7 +556,7 @@

Method Details

"A String", ], }, - "name": "A String", # The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id} + "name": "A String", # Identifier. The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id} "observedGeneration": "A String", # Output only. The generation of this Service currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. "reconciling": True or False, # Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state. When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revision`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Service, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in `terminal_condition` and `conditions`. "satisfiesPzs": True or False, # Output only. Reserved for future use. @@ -912,7 +912,7 @@

Method Details

"A String", ], }, - "name": "A String", # The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id} + "name": "A String", # Identifier. The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id} "observedGeneration": "A String", # Output only. The generation of this Service currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. "reconciling": True or False, # Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state. When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revision`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Service, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in `terminal_condition` and `conditions`. "satisfiesPzs": True or False, # Output only. Reserved for future use. @@ -1158,7 +1158,7 @@

Method Details

Updates a Service.
 
 Args:
-  name: string, The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id} (required)
+  name: string, Identifier. The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id} (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -1225,7 +1225,7 @@ 

Method Details

"A String", ], }, - "name": "A String", # The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id} + "name": "A String", # Identifier. The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id} "observedGeneration": "A String", # Output only. The generation of this Service currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. "reconciling": True or False, # Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state. When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revision`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Service, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in `terminal_condition` and `conditions`. "satisfiesPzs": True or False, # Output only. Reserved for future use. diff --git a/docs/dyn/servicenetworking_v1.operations.html b/docs/dyn/servicenetworking_v1.operations.html index 3ff8551c8f..6df90f3710 100644 --- a/docs/dyn/servicenetworking_v1.operations.html +++ b/docs/dyn/servicenetworking_v1.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/spanner_v1.projects.instances.backups.html b/docs/dyn/spanner_v1.projects.instances.backups.html index 72e40643d8..ad14b350cc 100644 --- a/docs/dyn/spanner_v1.projects.instances.backups.html +++ b/docs/dyn/spanner_v1.projects.instances.backups.html @@ -131,7 +131,7 @@

Method Details

"backupId": "A String", # Required. The id of the backup copy. The `backup_id` appended to `parent` forms the full backup_uri of the form `projects//instances//backups/`. "encryptionConfig": { # Encryption configuration for the copied backup. # Optional. The encryption configuration used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the source backup by default, namely encryption_type = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`. "encryptionType": "A String", # Required. The encryption type of the backup. - "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. + "kmsKeyName": "A String", # Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. KMS keys specified can be in any order. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. "A String", ], @@ -174,7 +174,7 @@

Method Details

Starts creating a new Cloud Spanner Backup. The returned backup long-running operation will have a name of the format `projects//instances//backups//operations/` and can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.
 
 Args:
-  parent: string, Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form `projects//instances/`. (required)
+  parent: string, Required. The name of the instance in which the backup is created. This must be the same instance that contains the database the backup is created from. The backup will be stored in the locations specified in the instance configuration of this instance. Values are of the form `projects//instances/`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -217,7 +217,7 @@ 

Method Details

"expireTime": "A String", # Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. "freeableSizeBytes": "A String", # Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired. "incrementalBackupChainId": "A String", # Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup `version_time`. - "instancePartitions": [ # Output only. The instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup's `version_time`. + "instancePartitions": [ # Output only. The instance partition storing the backup. This is the same as the list of the instance partitions that the database recorded at the backup's `version_time`. { # Instance partition information for the backup. "instancePartition": "A String", # A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/` }, @@ -243,7 +243,7 @@

Method Details

USE_DATABASE_ENCRYPTION - Use the same encryption configuration as the database. This is the default option when encryption_config is empty. For example, if the database is using `Customer_Managed_Encryption`, the backup will be using the same Cloud KMS key as the database. GOOGLE_DEFAULT_ENCRYPTION - Use Google default encryption. CUSTOMER_MANAGED_ENCRYPTION - Use customer managed encryption. If specified, `kms_key_name` must contain a valid Cloud KMS key. - encryptionConfig_kmsKeyName: string, Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. + encryptionConfig_kmsKeyName: string, Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. encryptionConfig_kmsKeyNames: string, Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. (repeated) x__xgafv: string, V1 error format. Allowed values @@ -345,7 +345,7 @@

Method Details

"expireTime": "A String", # Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. "freeableSizeBytes": "A String", # Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired. "incrementalBackupChainId": "A String", # Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup `version_time`. - "instancePartitions": [ # Output only. The instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup's `version_time`. + "instancePartitions": [ # Output only. The instance partition storing the backup. This is the same as the list of the instance partitions that the database recorded at the backup's `version_time`. { # Instance partition information for the backup. "instancePartition": "A String", # A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/` }, @@ -466,7 +466,7 @@

Method Details

"expireTime": "A String", # Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. "freeableSizeBytes": "A String", # Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired. "incrementalBackupChainId": "A String", # Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup `version_time`. - "instancePartitions": [ # Output only. The instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup's `version_time`. + "instancePartitions": [ # Output only. The instance partition storing the backup. This is the same as the list of the instance partitions that the database recorded at the backup's `version_time`. { # Instance partition information for the backup. "instancePartition": "A String", # A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/` }, @@ -551,7 +551,7 @@

Method Details

"expireTime": "A String", # Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. "freeableSizeBytes": "A String", # Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired. "incrementalBackupChainId": "A String", # Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup `version_time`. - "instancePartitions": [ # Output only. The instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup's `version_time`. + "instancePartitions": [ # Output only. The instance partition storing the backup. This is the same as the list of the instance partitions that the database recorded at the backup's `version_time`. { # Instance partition information for the backup. "instancePartition": "A String", # A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/` }, @@ -570,7 +570,7 @@

Method Details

"versionTime": "A String", # The backup will contain an externally consistent copy of the database at the timestamp specified by `version_time`. If `version_time` is not specified, the system will set `version_time` to the `create_time` of the backup. } - updateMask: string, Required. A mask specifying which fields (e.g. `expire_time`) in the Backup resource should be updated. This mask is relative to the Backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them. + updateMask: string, Required. A mask specifying which fields (for example, `expire_time`) in the backup resource should be updated. This mask is relative to the backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -618,7 +618,7 @@

Method Details

"expireTime": "A String", # Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. "freeableSizeBytes": "A String", # Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired. "incrementalBackupChainId": "A String", # Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup `version_time`. - "instancePartitions": [ # Output only. The instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup's `version_time`. + "instancePartitions": [ # Output only. The instance partition storing the backup. This is the same as the list of the instance partitions that the database recorded at the backup's `version_time`. { # Instance partition information for the backup. "instancePartition": "A String", # A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/` }, diff --git a/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html b/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html index 45ca038352..ba046e0ff5 100644 --- a/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html +++ b/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html @@ -122,7 +122,7 @@

Method Details

{ # BackupSchedule expresses the automated backup creation specification for a Spanner database. "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that is used to encrypt the backup. If this field is not specified, the backup uses the same encryption configuration as the database. "encryptionType": "A String", # Required. The encryption type of the backup. - "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. + "kmsKeyName": "A String", # Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. "A String", ], @@ -155,7 +155,7 @@

Method Details

{ # BackupSchedule expresses the automated backup creation specification for a Spanner database. "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that is used to encrypt the backup. If this field is not specified, the backup uses the same encryption configuration as the database. "encryptionType": "A String", # Required. The encryption type of the backup. - "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. + "kmsKeyName": "A String", # Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. "A String", ], @@ -212,7 +212,7 @@

Method Details

{ # BackupSchedule expresses the automated backup creation specification for a Spanner database. "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that is used to encrypt the backup. If this field is not specified, the backup uses the same encryption configuration as the database. "encryptionType": "A String", # Required. The encryption type of the backup. - "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. + "kmsKeyName": "A String", # Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. "A String", ], @@ -298,7 +298,7 @@

Method Details

{ # BackupSchedule expresses the automated backup creation specification for a Spanner database. "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that is used to encrypt the backup. If this field is not specified, the backup uses the same encryption configuration as the database. "encryptionType": "A String", # Required. The encryption type of the backup. - "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. + "kmsKeyName": "A String", # Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. "A String", ], @@ -349,7 +349,7 @@

Method Details

{ # BackupSchedule expresses the automated backup creation specification for a Spanner database. "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that is used to encrypt the backup. If this field is not specified, the backup uses the same encryption configuration as the database. "encryptionType": "A String", # Required. The encryption type of the backup. - "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. + "kmsKeyName": "A String", # Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. "A String", ], @@ -382,7 +382,7 @@

Method Details

{ # BackupSchedule expresses the automated backup creation specification for a Spanner database. "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that is used to encrypt the backup. If this field is not specified, the backup uses the same encryption configuration as the database. "encryptionType": "A String", # Required. The encryption type of the backup. - "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. + "kmsKeyName": "A String", # Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. "A String", ], diff --git a/docs/dyn/spanner_v1.projects.instances.databases.html b/docs/dyn/spanner_v1.projects.instances.databases.html index bcbba55d96..da47587de0 100644 --- a/docs/dyn/spanner_v1.projects.instances.databases.html +++ b/docs/dyn/spanner_v1.projects.instances.databases.html @@ -141,7 +141,7 @@

Instance Methods

Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance. Calling this method on a backup schedule that does not exist will result in a NOT_FOUND error if the user has `spanner.backupSchedules.list` permission on the containing database.

updateDdl(database, body=None, x__xgafv=None)

-

Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format `/operations/` and can be used to track execution of the schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response.

+

Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format `/operations/` and can be used to track execution of the schema changes. The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response.

Method Details

addSplitPoints(database, body=None, x__xgafv=None) @@ -198,7 +198,7 @@

Method Details

"dualRegion": { # Message type for a dual-region quorum. Currently this type has no options. # Dual-region quorum type. }, "singleRegion": { # Message type for a single-region quorum. # Single-region quorum type. - "servingLocation": "A String", # Required. The location of the serving region, e.g. "us-central1". The location must be one of the regions within the dual-region instance configuration of your database. The list of valid locations is available using the GetInstanceConfig API. This should only be used if you plan to change quorum to the single-region quorum type. + "servingLocation": "A String", # Required. The location of the serving region, for example, "us-central1". The location must be one of the regions within the dual-region instance configuration of your database. The list of valid locations is available using the GetInstanceConfig API. This should only be used if you plan to change quorum to the single-region quorum type. }, }, } @@ -357,7 +357,7 @@

Method Details

"dualRegion": { # Message type for a dual-region quorum. Currently this type has no options. # Dual-region quorum type. }, "singleRegion": { # Message type for a single-region quorum. # Single-region quorum type. - "servingLocation": "A String", # Required. The location of the serving region, e.g. "us-central1". The location must be one of the regions within the dual-region instance configuration of your database. The list of valid locations is available using the GetInstanceConfig API. This should only be used if you plan to change quorum to the single-region quorum type. + "servingLocation": "A String", # Required. The location of the serving region, for example, "us-central1". The location must be one of the regions within the dual-region instance configuration of your database. The list of valid locations is available using the GetInstanceConfig API. This should only be used if you plan to change quorum to the single-region quorum type. }, }, "startTime": "A String", # Output only. The timestamp when the request was triggered. @@ -700,7 +700,7 @@

Method Details

"dualRegion": { # Message type for a dual-region quorum. Currently this type has no options. # Dual-region quorum type. }, "singleRegion": { # Message type for a single-region quorum. # Single-region quorum type. - "servingLocation": "A String", # Required. The location of the serving region, e.g. "us-central1". The location must be one of the regions within the dual-region instance configuration of your database. The list of valid locations is available using the GetInstanceConfig API. This should only be used if you plan to change quorum to the single-region quorum type. + "servingLocation": "A String", # Required. The location of the serving region, for example, "us-central1". The location must be one of the regions within the dual-region instance configuration of your database. The list of valid locations is available using the GetInstanceConfig API. This should only be used if you plan to change quorum to the single-region quorum type. }, }, "startTime": "A String", # Output only. The timestamp when the request was triggered. @@ -781,7 +781,7 @@

Method Details

"dualRegion": { # Message type for a dual-region quorum. Currently this type has no options. # Dual-region quorum type. }, "singleRegion": { # Message type for a single-region quorum. # Single-region quorum type. - "servingLocation": "A String", # Required. The location of the serving region, e.g. "us-central1". The location must be one of the regions within the dual-region instance configuration of your database. The list of valid locations is available using the GetInstanceConfig API. This should only be used if you plan to change quorum to the single-region quorum type. + "servingLocation": "A String", # Required. The location of the serving region, for example, "us-central1". The location must be one of the regions within the dual-region instance configuration of your database. The list of valid locations is available using the GetInstanceConfig API. This should only be used if you plan to change quorum to the single-region quorum type. }, }, "startTime": "A String", # Output only. The timestamp when the request was triggered. @@ -844,7 +844,7 @@

Method Details

"databaseId": "A String", # Required. The id of the database to create and restore to. This database must not already exist. The `database_id` appended to `parent` forms the full database name of the form `projects//instances//databases/`. "encryptionConfig": { # Encryption configuration for the restored database. # Optional. An encryption configuration describing the encryption type and key resources in Cloud KMS used to encrypt/decrypt the database to restore to. If this field is not specified, the restored database will use the same encryption configuration as the backup by default, namely encryption_type = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`. "encryptionType": "A String", # Required. The encryption type of the restored database. - "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored database. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. + "kmsKeyName": "A String", # Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. "kmsKeyNames": [ # Optional. Specifies the KMS configuration for one or more keys used to encrypt the database. Values have the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the database's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. "A String", ], @@ -970,14 +970,14 @@

Method Details

updateDdl(database, body=None, x__xgafv=None) -
Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format `/operations/` and can be used to track execution of the schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response.
+  
Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format `/operations/` and can be used to track execution of the schema changes. The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response.
 
 Args:
   database: string, Required. The database to update. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (e.g., if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a `NULL` value in a column to which `NOT NULL` would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled. Each batch of statements is assigned a name which can be used with the Operations API to monitor progress. See the operation_id field for more details.
+{ # Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (for example, if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a `NULL` value in a column to which `NOT NULL` would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled. Each batch of statements is assigned a name which can be used with the Operations API to monitor progress. See the operation_id field for more details.
   "operationId": "A String", # If empty, the new update request is assigned an automatically-generated operation ID. Otherwise, `operation_id` is used to construct the name of the resulting Operation. Specifying an explicit operation ID simplifies determining whether the statements were executed in the event that the UpdateDatabaseDdl call is replayed, or the return value is otherwise lost: the database and `operation_id` fields can be combined to form the `name` of the resulting longrunning.Operation: `/operations/`. `operation_id` should be unique within the database, and must be a valid identifier: `a-z*`. Note that automatically-generated operation IDs always begin with an underscore. If the named operation already exists, UpdateDatabaseDdl returns `ALREADY_EXISTS`.
   "protoDescriptors": "A String", # Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description).
   "statements": [ # Required. DDL statements to be applied to the database.
diff --git a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html
index a762dad101..dcd58f54ef 100644
--- a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html
+++ b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html
@@ -161,6 +161,7 @@ 

Method Details

An object of the form: { # Message sent by the adapter to the client. + "last": True or False, # Optional. Indicates whether this is the last AdaptMessageResponse in the stream. This field may be optionally set by the server. Clients should not rely on this field being set in all cases. "payload": "A String", # Optional. Uninterpreted bytes from the underlying wire protocol. "stateUpdates": { # Optional. Opaque state updates to be applied by the client. "a_key": "A String", @@ -628,6 +629,7 @@

Method Details

"precommitToken": "A String", # Opaque precommit token. "seqNum": 42, # An incrementing seq number is generated on every precommit token that is returned. Clients should remember the precommit token with the highest sequence number from the current transaction attempt. }, + "snapshotTimestamp": "A String", # If `TransactionOptions.isolation_level` is set to `IsolationLevel.REPEATABLE_READ`, then the snapshot timestamp is the timestamp at which all reads in the transaction ran. This timestamp is never returned. }
diff --git a/docs/dyn/spanner_v1.projects.instances.html b/docs/dyn/spanner_v1.projects.instances.html index d8ecf486f6..3e10343fbc 100644 --- a/docs/dyn/spanner_v1.projects.instances.html +++ b/docs/dyn/spanner_v1.projects.instances.html @@ -172,7 +172,7 @@

Method Details

"autoscalingTargetHighPriorityCpuUtilizationPercent": 42, # Optional. If specified, overrides the autoscaling target high_priority_cpu_utilization_percent in the top-level autoscaling configuration for the selected replicas. }, "replicaSelection": { # ReplicaSelection identifies replicas with common properties. # Required. Selects the replicas to which this AsymmetricAutoscalingOption applies. Only read-only replicas are supported. - "location": "A String", # Required. Name of the location of the replicas (e.g., "us-central1"). + "location": "A String", # Required. Name of the location of the replicas (for example, "us-central1"). }, }, ], @@ -212,7 +212,7 @@

Method Details

"nodeCount": 42, # The number of nodes allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`. "processingUnits": 42, # The number of processing units allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`. "replicaSelection": { # ReplicaSelection identifies replicas with common properties. # Required. Identifies replicas by specified properties. All replicas in the selection have the same amount of compute capacity. - "location": "A String", # Required. Name of the location of the replicas (e.g., "us-central1"). + "location": "A String", # Required. Name of the location of the replicas (for example, "us-central1"). }, }, ], @@ -298,7 +298,7 @@

Method Details

"autoscalingTargetHighPriorityCpuUtilizationPercent": 42, # Optional. If specified, overrides the autoscaling target high_priority_cpu_utilization_percent in the top-level autoscaling configuration for the selected replicas. }, "replicaSelection": { # ReplicaSelection identifies replicas with common properties. # Required. Selects the replicas to which this AsymmetricAutoscalingOption applies. Only read-only replicas are supported. - "location": "A String", # Required. Name of the location of the replicas (e.g., "us-central1"). + "location": "A String", # Required. Name of the location of the replicas (for example, "us-central1"). }, }, ], @@ -338,7 +338,7 @@

Method Details

"nodeCount": 42, # The number of nodes allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`. "processingUnits": 42, # The number of processing units allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`. "replicaSelection": { # ReplicaSelection identifies replicas with common properties. # Required. Identifies replicas by specified properties. All replicas in the selection have the same amount of compute capacity. - "location": "A String", # Required. Name of the location of the replicas (e.g., "us-central1"). + "location": "A String", # Required. Name of the location of the replicas (for example, "us-central1"). }, }, ], @@ -424,7 +424,7 @@

Method Details

"autoscalingTargetHighPriorityCpuUtilizationPercent": 42, # Optional. If specified, overrides the autoscaling target high_priority_cpu_utilization_percent in the top-level autoscaling configuration for the selected replicas. }, "replicaSelection": { # ReplicaSelection identifies replicas with common properties. # Required. Selects the replicas to which this AsymmetricAutoscalingOption applies. Only read-only replicas are supported. - "location": "A String", # Required. Name of the location of the replicas (e.g., "us-central1"). + "location": "A String", # Required. Name of the location of the replicas (for example, "us-central1"). }, }, ], @@ -464,7 +464,7 @@

Method Details

"nodeCount": 42, # The number of nodes allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`. "processingUnits": 42, # The number of processing units allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`. "replicaSelection": { # ReplicaSelection identifies replicas with common properties. # Required. Identifies replicas by specified properties. All replicas in the selection have the same amount of compute capacity. - "location": "A String", # Required. Name of the location of the replicas (e.g., "us-central1"). + "location": "A String", # Required. Name of the location of the replicas (for example, "us-central1"). }, }, ], @@ -508,7 +508,7 @@

Method Details

{ # The configuration for each database in the target instance configuration. "databaseId": "A String", # Required. The unique identifier of the database resource in the Instance. For example, if the database uri is `projects/foo/instances/bar/databases/baz`, then the id to supply here is baz. "encryptionConfig": { # Encryption configuration for a Cloud Spanner database. # Optional. Encryption configuration to be used for the database in the target configuration. The encryption configuration must be specified for every database which currently uses CMEK encryption. If a database currently uses Google-managed encryption and a target encryption configuration is not specified, then the database defaults to Google-managed encryption. If a database currently uses Google-managed encryption and a target CMEK encryption is specified, the request is rejected. If a database currently uses CMEK encryption, then a target encryption configuration must be specified. You can't move a CMEK database to a Google-managed encryption database using the MoveInstance API. - "kmsKeyName": "A String", # Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. `kms_key_name` should only be used if the location of the KMS key matches the database instance’s configuration (location) exactly. E.g. The KMS location is in us-central1 or nam3 and the database instance is also in us-central1 or nam3. The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. + "kmsKeyName": "A String", # Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. "kmsKeyNames": [ # Optional. Specifies the KMS configuration for one or more keys used to encrypt the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the database's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. "A String", ], @@ -571,7 +571,7 @@

Method Details

"autoscalingTargetHighPriorityCpuUtilizationPercent": 42, # Optional. If specified, overrides the autoscaling target high_priority_cpu_utilization_percent in the top-level autoscaling configuration for the selected replicas. }, "replicaSelection": { # ReplicaSelection identifies replicas with common properties. # Required. Selects the replicas to which this AsymmetricAutoscalingOption applies. Only read-only replicas are supported. - "location": "A String", # Required. Name of the location of the replicas (e.g., "us-central1"). + "location": "A String", # Required. Name of the location of the replicas (for example, "us-central1"). }, }, ], @@ -611,7 +611,7 @@

Method Details

"nodeCount": 42, # The number of nodes allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`. "processingUnits": 42, # The number of processing units allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`. "replicaSelection": { # ReplicaSelection identifies replicas with common properties. # Required. Identifies replicas by specified properties. All replicas in the selection have the same amount of compute capacity. - "location": "A String", # Required. Name of the location of the replicas (e.g., "us-central1"). + "location": "A String", # Required. Name of the location of the replicas (for example, "us-central1"). }, }, ], diff --git a/docs/dyn/speech_v1.operations.html b/docs/dyn/speech_v1.operations.html index 08473c00b9..d45188deea 100644 --- a/docs/dyn/speech_v1.operations.html +++ b/docs/dyn/speech_v1.operations.html @@ -81,7 +81,7 @@

Instance Methods

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.

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

+ list(filter=None, name=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -128,7 +128,7 @@

Method Details

- list(filter=None, name=None, pageSize=None, pageToken=None, x__xgafv=None) + list(filter=None, name=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -136,6 +136,7 @@ 

Method Details

name: string, The name of the operation's parent resource. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -167,6 +168,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/speech_v1p1beta1.operations.html b/docs/dyn/speech_v1p1beta1.operations.html index 01f9f8d8e2..75e92e732b 100644 --- a/docs/dyn/speech_v1p1beta1.operations.html +++ b/docs/dyn/speech_v1p1beta1.operations.html @@ -81,7 +81,7 @@

Instance Methods

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.

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

+ list(filter=None, name=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -128,7 +128,7 @@

Method Details

- list(filter=None, name=None, pageSize=None, pageToken=None, x__xgafv=None) + list(filter=None, name=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -136,6 +136,7 @@ 

Method Details

name: string, The name of the operation's parent resource. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -167,6 +168,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/storagebatchoperations_v1.projects.locations.operations.html b/docs/dyn/storagebatchoperations_v1.projects.locations.operations.html index b3d8985825..5084389947 100644 --- a/docs/dyn/storagebatchoperations_v1.projects.locations.operations.html +++ b/docs/dyn/storagebatchoperations_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/vmwareengine_v1.projects.locations.html b/docs/dyn/vmwareengine_v1.projects.locations.html index 6197bd2b38..5b31e5b316 100644 --- a/docs/dyn/vmwareengine_v1.projects.locations.html +++ b/docs/dyn/vmwareengine_v1.projects.locations.html @@ -198,7 +198,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/webrisk_v1.projects.operations.html b/docs/dyn/webrisk_v1.projects.operations.html index bac86cbc1d..b30ec55def 100644 --- a/docs/dyn/webrisk_v1.projects.operations.html +++ b/docs/dyn/webrisk_v1.projects.operations.html @@ -87,7 +87,7 @@

Instance Methods

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.

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

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -184,6 +184,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/workloadmanager_v1.projects.locations.evaluations.html b/docs/dyn/workloadmanager_v1.projects.locations.evaluations.html index 9c27172b8d..8491a4e507 100644 --- a/docs/dyn/workloadmanager_v1.projects.locations.evaluations.html +++ b/docs/dyn/workloadmanager_v1.projects.locations.evaluations.html @@ -97,6 +97,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

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

+

Updates the parameters of a single Evaluation.

Method Details

close() @@ -374,4 +377,90 @@

Method Details

+
+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None) +
Updates the parameters of a single Evaluation.
+
+Args:
+  name: string, name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}' (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing Evaluation object
+  "bigQueryDestination": { # Message describing big query destination # Optional. BigQuery destination
+    "createNewResultsTable": True or False, # Optional. determine if results will be saved in a new table
+    "destinationDataset": "A String", # Optional. destination dataset to save evaluation results
+  },
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "customRulesBucket": "A String", # The Cloud Storage bucket name for custom rules.
+  "description": "A String", # Description of the Evaluation
+  "evaluationType": "A String", # Evaluation type
+  "kmsKey": "A String", # Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.
+  "labels": { # Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'
+  "resourceFilter": { # Message describing resource filters # annotations as key value pairs
+    "gceInstanceFilter": { # Message describing compute engine instance filter # Filter compute engine resource
+      "serviceAccounts": [ # Service account of compute engine
+        "A String",
+      ],
+    },
+    "inclusionLabels": { # The label used for filter resource
+      "a_key": "A String",
+    },
+    "resourceIdPatterns": [ # The id pattern for filter resource
+      "A String",
+    ],
+    "scopes": [ # The scopes of evaluation resource
+      "A String",
+    ],
+  },
+  "resourceStatus": { # Message describing resource status # Output only. [Output only] The updated rule ids if exist.
+    "rulesNewerVersions": [ # Historical: Used before 2023-05-22 the new version of rule id if exists
+      "A String",
+    ],
+    "state": "A String", # State of the resource
+  },
+  "ruleNames": [ # the name of the rule
+    "A String",
+  ],
+  "ruleVersions": [ # Output only. [Output only] The updated rule ids if exist.
+    "A String",
+  ],
+  "schedule": "A String", # crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *",
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+}
+
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Evaluation resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.
+  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.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/workloadmanager_v1.projects.locations.rules.html b/docs/dyn/workloadmanager_v1.projects.locations.rules.html index 8b48c947fc..ce08ff0dfc 100644 --- a/docs/dyn/workloadmanager_v1.projects.locations.rules.html +++ b/docs/dyn/workloadmanager_v1.projects.locations.rules.html @@ -80,9 +80,6 @@

Instance Methods

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

Lists rules in a given project.

-

- list_next()

-

Retrieves the next page of results.

Method Details

close() @@ -115,7 +112,16 @@

Method Details

An object of the form: { # Mesesage of response of list rules - "nextPageToken": "A String", # A token identifying a page of results the server should return. + "invalidRulesWrapper": { # Message wrappes a list of invalid rules. # A wrapper of the invalid rules that failed to be validated. + "invalidRules": [ # The invalid rules that failed to be validated. + { # Message represent an rule that failed to be validated. + "displayName": "A String", # display name of the invalid rule + "gcsUri": "A String", # cloud storage destination of the invalid rule + "name": "A String", # name of the invalid rule + "valiadtionError": "A String", # The error message of valdating rule formats. + }, + ], + }, "rules": [ # all rules in response { # Message represent a rule "description": "A String", # descrite rule in plain language @@ -137,18 +143,4 @@

Method Details

}
-
- 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/googleapiclient/discovery_cache/documents/admin.directory_v1.json b/googleapiclient/discovery_cache/documents/admin.directory_v1.json index 83dee5619f..21015f8f43 100644 --- a/googleapiclient/discovery_cache/documents/admin.directory_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.directory_v1.json @@ -1659,7 +1659,7 @@ "type": "string" }, "query": { -"description": "Query string search. Should be of the form \"\". Complete documentation is at https://developers.google.com/workspace/admin/directory/v1/guides/search-groups", +"description": "Query string search. Contains one or more search clauses, each with a field, operator, and value. For complete documentation, go to [Search for groups](https://developers.google.com/workspace/admin/directory/v1/guides/search-groups).", "location": "query", "type": "string" }, @@ -2896,7 +2896,7 @@ "type": "string" }, "query": { -"description": "String query used to filter results. Should be of the form \"field operator value\" where field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match, '!=' for mismatch and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a *. Logical operators NOT and AND are supported (in this order of precedence). Supported fields include `generatedResourceName`, `name`, `buildingId`, `floor_name`, `capacity`, `featureInstances.feature.name`, `resourceEmail`, `resourceCategory`. For example `buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone`.", +"description": "String query used to filter results. Contains one or more search clauses, each with a field, operator, and value. A field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match, '!=' for mismatch and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a *. Logical operators NOT and AND are supported (in this order of precedence). Supported fields include `generatedResourceName`, `name`, `buildingId`, `floor_name`, `capacity`, `featureInstances.feature.name`, `resourceEmail`, `resourceCategory`. For example `buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone`.", "location": "query", "type": "string" } @@ -4298,7 +4298,7 @@ "type": "string" }, "query": { -"description": "Query string search. Should be of the form \"\". Complete documentation is at https://developers.google.com/workspace/admin/directory/v1/guides/search-users", +"description": "Query string search. Contains one or more search clauses, each with a field, operator, and value. For complete documentation, go to [Search for users](https://developers.google.com/workspace/admin/directory/v1/guides/search-users).", "location": "query", "type": "string" }, @@ -4671,7 +4671,7 @@ } } }, -"revision": "20250916", +"revision": "20250930", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { diff --git a/googleapiclient/discovery_cache/documents/adsense.v2.json b/googleapiclient/discovery_cache/documents/adsense.v2.json index 5efbfa9604..b26c334af5 100644 --- a/googleapiclient/discovery_cache/documents/adsense.v2.json +++ b/googleapiclient/discovery_cache/documents/adsense.v2.json @@ -991,6 +991,8 @@ "PLATFORM_TYPE_CODE", "TARGETING_TYPE_NAME", "TARGETING_TYPE_CODE", +"TRAFFIC_SOURCE_NAME", +"TRAFFIC_SOURCE_CODE", "CONTENT_PLATFORM_NAME", "CONTENT_PLATFORM_CODE", "AD_PLACEMENT_NAME", @@ -1055,6 +1057,8 @@ false, false, false, false, +false, +false, false ], "enumDescriptions": [ @@ -1093,6 +1097,8 @@ false "Platform type code (e.g. \"HighEndMobile\", \"Desktop\").", "Localized targeting type name (e.g. \"Contextual\", \"Personalized\", \"Run of Network\").", "Targeting type code (e.g. \"Keyword\", \"UserInterest\", \"RunOfNetwork\").", +"Localized traffic source name (e.g. \"Google\", \"Bing\", \"Facebook\", \"Other\"). For more information, see [Traffic source breakdown](https://support.google.com/adsense/answer/16474600).", +"Traffic source code (e.g. \"GOOGLE\", \"BING\", \"FACEBOOK\", \"OTHER\"). For more information, see [Traffic source breakdown](https://support.google.com/adsense/answer/16474600).", "Localized content platform name an ad request was made from (e.g. \"AMP\", \"Web\").", "Content platform code an ad request was made from (e.g. \"AMP\", \"HTML\").", "Localized ad placement name (e.g. \"Ad unit\", \"Global settings\", \"Manual\").", @@ -1364,6 +1370,8 @@ false "PLATFORM_TYPE_CODE", "TARGETING_TYPE_NAME", "TARGETING_TYPE_CODE", +"TRAFFIC_SOURCE_NAME", +"TRAFFIC_SOURCE_CODE", "CONTENT_PLATFORM_NAME", "CONTENT_PLATFORM_CODE", "AD_PLACEMENT_NAME", @@ -1428,6 +1436,8 @@ false, false, false, false, +false, +false, false ], "enumDescriptions": [ @@ -1466,6 +1476,8 @@ false "Platform type code (e.g. \"HighEndMobile\", \"Desktop\").", "Localized targeting type name (e.g. \"Contextual\", \"Personalized\", \"Run of Network\").", "Targeting type code (e.g. \"Keyword\", \"UserInterest\", \"RunOfNetwork\").", +"Localized traffic source name (e.g. \"Google\", \"Bing\", \"Facebook\", \"Other\"). For more information, see [Traffic source breakdown](https://support.google.com/adsense/answer/16474600).", +"Traffic source code (e.g. \"GOOGLE\", \"BING\", \"FACEBOOK\", \"OTHER\"). For more information, see [Traffic source breakdown](https://support.google.com/adsense/answer/16474600).", "Localized content platform name an ad request was made from (e.g. \"AMP\", \"Web\").", "Content platform code an ad request was made from (e.g. \"AMP\", \"HTML\").", "Localized ad placement name (e.g. \"Ad unit\", \"Global settings\", \"Manual\").", @@ -2018,7 +2030,7 @@ false } } }, -"revision": "20250624", +"revision": "20251002", "rootUrl": "https://adsense.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index aa7b82d567..6069cd99bb 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -10075,7 +10075,7 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.", +"description": "The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", "format": "int32", "location": "query", "type": "integer" @@ -10213,7 +10213,7 @@ "type": "string" }, "pageSize": { -"description": "The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.", +"description": "The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", "format": "int32", "location": "query", "type": "integer" @@ -10668,7 +10668,7 @@ "type": "string" }, "pageSize": { -"description": "The maximum number of Contexts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.", +"description": "The maximum number of Contexts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", "format": "int32", "location": "query", "type": "integer" @@ -11107,7 +11107,7 @@ "type": "string" }, "pageSize": { -"description": "The maximum number of Executions to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.", +"description": "The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", "format": "int32", "location": "query", "type": "integer" @@ -11455,7 +11455,7 @@ "type": "string" }, "pageSize": { -"description": "The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.", +"description": "The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", "format": "int32", "location": "query", "type": "integer" @@ -20930,7 +20930,7 @@ } } }, -"revision": "20250920", +"revision": "20250926", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -39846,7 +39846,7 @@ false }, "packageSpec": { "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec", -"description": "Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes." +"description": "Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified." }, "serviceAccount": { "description": "Optional. The service account that the Reasoning Engine artifact runs as. It should have \"roles/storage.objectViewer\" for reading the user project's Cloud Storage and \"roles/aiplatform.user\" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used.", @@ -39903,7 +39903,7 @@ false "type": "object" }, "GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec": { -"description": "User provided package spec like pickled object and package requirements.", +"description": "User-provided package specification, containing pickled object and package requirements.", "id": "GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec", "properties": { "dependencyFilesGcsUri": { diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index e68d2738ca..350a1f398f 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -12775,7 +12775,7 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.", +"description": "The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", "format": "int32", "location": "query", "type": "integer" @@ -12913,7 +12913,7 @@ "type": "string" }, "pageSize": { -"description": "The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.", +"description": "The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", "format": "int32", "location": "query", "type": "integer" @@ -13368,7 +13368,7 @@ "type": "string" }, "pageSize": { -"description": "The maximum number of Contexts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.", +"description": "The maximum number of Contexts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", "format": "int32", "location": "query", "type": "integer" @@ -13807,7 +13807,7 @@ "type": "string" }, "pageSize": { -"description": "The maximum number of Executions to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.", +"description": "The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", "format": "int32", "location": "query", "type": "integer" @@ -14155,7 +14155,7 @@ "type": "string" }, "pageSize": { -"description": "The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.", +"description": "The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", "format": "int32", "location": "query", "type": "integer" @@ -26923,7 +26923,7 @@ } } }, -"revision": "20250920", +"revision": "20250926", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -50022,7 +50022,7 @@ false }, "packageSpec": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec", -"description": "Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes." +"description": "Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified." }, "serviceAccount": { "description": "Optional. The service account that the Reasoning Engine artifact runs as. It should have \"roles/storage.objectViewer\" for reading the user project's Cloud Storage and \"roles/aiplatform.user\" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used.", @@ -50093,7 +50093,7 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec": { -"description": "User provided package spec like pickled object and package requirements.", +"description": "User-provided package specification, containing pickled object and package requirements.", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec", "properties": { "dependencyFilesGcsUri": { diff --git a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json index 7dd56bbb8d..4b7b0facb3 100644 --- a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json @@ -423,7 +423,7 @@ } } }, -"revision": "20250414", +"revision": "20250929", "rootUrl": "https://alertcenter.googleapis.com/", "schemas": { "AbuseDetected": { @@ -530,7 +530,8 @@ "FRAUD", "NUMBER_HARVESTING", "PAYMENTS_FRAUD", -"UNWANTED_CONTENT" +"UNWANTED_CONTENT", +"UNQUALIFIED_EDU" ], "enumDescriptions": [ "Abuse reason is unspecified.", @@ -541,7 +542,8 @@ "This account is being suspended for fraud.", "This account is being suspended for number harvesting.", "This account is being suspended for payments fraud.", -"This account is being suspended for unwanted content." +"This account is being suspended for unwanted content.", +"This account is being suspended for being an unqualified educational institution." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1.json b/googleapiclient/discovery_cache/documents/alloydb.v1.json index 55fdaeb3a7..5613757836 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1.json @@ -1550,6 +1550,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1622,7 +1627,7 @@ } } }, -"revision": "20250910", +"revision": "20250925", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1636,6 +1641,24 @@ }, "type": "object" }, +"AutoScalingConfig": { +"description": "Configuration for autoscaling.", +"id": "AutoScalingConfig", +"properties": { +"policy": { +"$ref": "Policy", +"description": "Policy for the MIG autoscaler." +}, +"schedules": { +"description": "Optional list of schedules for the MIG autoscaler. If not set, no schedules are created.", +"items": { +"$ref": "Schedule" +}, +"type": "array" +} +}, +"type": "object" +}, "AutomatedBackupPolicy": { "description": "Message describing the user-specified automated backup policy. All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set.", "id": "AutomatedBackupPolicy", @@ -1862,6 +1885,99 @@ false }, "type": "object" }, +"BackupDrBackupSource": { +"description": "Message describing a BackupDrBackupSource.", +"id": "BackupDrBackupSource", +"properties": { +"backup": { +"description": "Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id}", +"type": "string" +} +}, +"type": "object" +}, +"BackupDrEnabledWindow": { +"description": "Information about a single window when BackupDR was enabled for this cluster.", +"id": "BackupDrEnabledWindow", +"properties": { +"automatedBackupPreviouslyEnabled": { +"description": "Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster.", +"type": "boolean" +}, +"backupPlanAssociation": { +"description": "The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster.", +"type": "string" +}, +"continuousBackupPreviousRecoveryWindowDays": { +"description": "The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster.", +"format": "int32", +"type": "integer" +}, +"continuousBackupPreviouslyEnabled": { +"description": "Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster.", +"type": "boolean" +}, +"continuousBackupPreviouslyEnabledTime": { +"description": "The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster.", +"format": "google-datetime", +"type": "string" +}, +"dataSource": { +"description": "The DataSource resource that represents the cluster in BackupDR.", +"type": "string" +}, +"disabledTime": { +"description": "Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`.", +"format": "google-datetime", +"type": "string" +}, +"enabledTime": { +"description": "Time when the BackupDR protection for this cluster was enabled.", +"format": "google-datetime", +"type": "string" +}, +"logRetentionPeriod": { +"description": "The retention period for logs generated by BackupDR for this cluster.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"BackupDrInfo": { +"description": "Information about BackupDR protection for this cluster.", +"id": "BackupDrInfo", +"properties": { +"currentWindow": { +"$ref": "BackupDrEnabledWindow", +"description": "The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty." +}, +"previousWindows": { +"description": "Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list.", +"items": { +"$ref": "BackupDrEnabledWindow" +}, +"type": "array" +} +}, +"type": "object" +}, +"BackupDrPitrSource": { +"description": "Message describing a BackupDrPitrSource.", +"id": "BackupDrPitrSource", +"properties": { +"dataSource": { +"description": "Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}", +"type": "string" +}, +"pointInTime": { +"description": "Required. The point in time to restore to.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "BackupSource": { "description": "Message describing a BackupSource.", "id": "BackupSource", @@ -1970,6 +2086,16 @@ false "description": "Output only. Cluster created from backup.", "readOnly": true }, +"backupdrBackupSource": { +"$ref": "BackupDrBackupSource", +"description": "Output only. Cluster created from a BackupDR backup.", +"readOnly": true +}, +"backupdrInfo": { +"$ref": "BackupDrInfo", +"description": "Output only. Output only information about BackupDR protection for this cluster.", +"readOnly": true +}, "cloudsqlBackupRunSource": { "$ref": "CloudSQLBackupRunSource", "description": "Output only. Cluster created from CloudSQL snapshot.", @@ -2420,6 +2546,18 @@ false }, "type": "object" }, +"CpuUtilization": { +"description": "CPU utilization policy for the autoscaler.", +"id": "CpuUtilization", +"properties": { +"utilizationTarget": { +"description": "Target CPU utilization as a float between 0 and 1.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, "CsvExportOptions": { "description": "Options for exporting data in CSV format.", "id": "CsvExportOptions", @@ -3166,6 +3304,13 @@ false "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -3496,6 +3641,31 @@ false }, "type": "object" }, +"Policy": { +"description": "Policy for the autoscaler.", +"id": "Policy", +"properties": { +"coolDownPeriodSec": { +"description": "The period of time in seconds after a new node is created before the autoscaler will incorporate its resource usage (e.g. CPU utilization) into the autoscaling recommendation algorithm.", +"format": "int64", +"type": "string" +}, +"cpuUtilization": { +"$ref": "CpuUtilization", +"description": "CPU utilization policy for the autoscaler." +}, +"enabled": { +"description": "If true, autoscaling is enabled for the instance. If not set, the default value is false.", +"type": "boolean" +}, +"maxNodeCount": { +"description": "Maximum number of nodes for the autoscaler.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "PrimaryConfig": { "description": "Configuration for the primary cluster. It has the list of clusters that are replicating from this cluster. This should be set if and only if the cluster is of type PRIMARY.", "id": "PrimaryConfig", @@ -3686,6 +3856,10 @@ false "description": "Configuration for a read pool instance.", "id": "ReadPoolConfig", "properties": { +"autoScalingConfig": { +"$ref": "AutoScalingConfig", +"description": "Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled." +}, "nodeCount": { "description": "Read capacity, i.e. number of nodes in a read pool instance.", "format": "int32", @@ -3734,6 +3908,14 @@ false "$ref": "BackupSource", "description": "Backup source." }, +"backupdrBackupSource": { +"$ref": "BackupDrBackupSource", +"description": "BackupDR backup source." +}, +"backupdrPitrSource": { +"$ref": "BackupDrPitrSource", +"description": "BackupDR source used for point in time recovery." +}, "cluster": { "$ref": "Cluster", "description": "Required. The resource being created" @@ -3776,6 +3958,43 @@ false }, "type": "object" }, +"Schedule": { +"description": "A schedule for the autoscaler.", +"id": "Schedule", +"properties": { +"cronExpression": { +"description": "Cron expression for the triggering the schedule. See https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions for the syntax.", +"type": "string" +}, +"description": { +"description": "Description of the schedule.", +"type": "string" +}, +"disabled": { +"description": "If true, the schedule is disabled.", +"type": "boolean" +}, +"durationSec": { +"description": "Duration of the schedule.", +"format": "int64", +"type": "string" +}, +"minNodeCount": { +"description": "Minimum number of nodes in while the schedule is active.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "Name of the schedule.", +"type": "string" +}, +"timeZone": { +"description": "The location-based IANA time zone for interpreting the schedule's start time. If no time zone is provided, UTC is used by default.", +"type": "string" +} +}, +"type": "object" +}, "SecondaryConfig": { "description": "Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY.", "id": "SecondaryConfig", @@ -3925,33 +4144,6 @@ false }, "type": "object" }, -"StageSchedule": { -"description": "Timing information for the stage execution.", -"id": "StageSchedule", -"properties": { -"actualEndTime": { -"description": "Actual end time of the stage. Set only if the stage has completed.", -"format": "google-datetime", -"type": "string" -}, -"actualStartTime": { -"description": "Actual start time of the stage. Set only if the stage has started.", -"format": "google-datetime", -"type": "string" -}, -"estimatedEndTime": { -"description": "When the stage is expected to end. Set only if the stage has not completed yet.", -"format": "google-datetime", -"type": "string" -}, -"estimatedStartTime": { -"description": "When the stage is expected to start. Set only if the stage has not started yet.", -"format": "google-datetime", -"type": "string" -} -}, -"type": "object" -}, "StageStatus": { "description": "Status of an upgrade stage.", "id": "StageStatus", @@ -3960,11 +4152,6 @@ false "$ref": "ReadPoolInstancesUpgradeStageStatus", "description": "Read pool instances upgrade metadata." }, -"schedule": { -"$ref": "StageSchedule", -"description": "Output only. Timing information for the stage execution.", -"readOnly": true -}, "stage": { "description": "Upgrade stage.", "enum": [ @@ -4836,7 +5023,7 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { -"description": "Common model for database resource instance metadata. Next ID: 27", +"description": "Common model for database resource instance metadata. Next ID: 29", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -4987,6 +5174,10 @@ false "$ref": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", "description": "Machine configuration for this resource." }, +"maintenanceInfo": { +"$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo", +"description": "Optional. Maintenance info for the resource." +}, "primaryResourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." @@ -5692,6 +5883,100 @@ false }, "type": "object" }, +"StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule": { +"description": "Deny maintenance period for the database resource. It specifies the time range during which the maintenance cannot start. This is configured by the customer.", +"id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule", +"properties": { +"endDate": { +"$ref": "GoogleTypeDate", +"description": "Optional. Deny period end date." +}, +"startDate": { +"$ref": "GoogleTypeDate", +"description": "Optional. The start date of the deny maintenance period." +}, +"time": { +"$ref": "GoogleTypeTimeOfDay", +"description": "Optional. Time in UTC when the deny period starts on start_date and ends on end_date." +} +}, +"type": "object" +}, +"StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo": { +"description": "MaintenanceInfo to capture the maintenance details of database resource.", +"id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo", +"properties": { +"denyMaintenanceSchedules": { +"description": "Optional. List of Deny maintenance period for the database resource.", +"items": { +"$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule" +}, +"type": "array" +}, +"maintenanceSchedule": { +"$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule", +"description": "Optional. Maintenance window for the database resource." +}, +"maintenanceVersion": { +"description": "Optional. Current Maintenance version of the database resource. Example: \"MYSQL_8_0_41.R20250531.01_15\"", +"type": "string" +} +}, +"type": "object" +}, +"StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule": { +"description": "Maintenance window for the database resource. It specifies preferred time and day of the week and phase in some cases, when the maintenance can start. This is configured by the customer.", +"id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule", +"properties": { +"day": { +"description": "Optional. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.", +"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" +}, +"phase": { +"description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance", +"enum": [ +"WINDOW_PHASE_UNSPECIFIED", +"WINDOW_PHASE_ANY", +"WINDOW_PHASE_WEEK1", +"WINDOW_PHASE_WEEK2", +"WINDOW_PHASE_WEEK5" +], +"enumDescriptions": [ +"Phase is unspecified.", +"Any phase.", +"Week 1.", +"Week 2.", +"Week 5." +], +"type": "string" +}, +"time": { +"$ref": "GoogleTypeTimeOfDay", +"description": "Optional. Preferred time to start the maintenance operation on the specified day." +} +}, +"type": "object" +}, "StorageDatabasecenterPartnerapiV1mainRetentionSettings": { "id": "StorageDatabasecenterPartnerapiV1mainRetentionSettings", "properties": { diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json index b820349c51..fa6fa13668 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json @@ -1550,6 +1550,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -1622,7 +1627,7 @@ } } }, -"revision": "20250910", +"revision": "20250925", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1636,6 +1641,24 @@ }, "type": "object" }, +"AutoScalingConfig": { +"description": "Configuration for autoscaling.", +"id": "AutoScalingConfig", +"properties": { +"policy": { +"$ref": "Policy", +"description": "Policy for the MIG autoscaler." +}, +"schedules": { +"description": "Optional list of schedules for the MIG autoscaler. If not set, no schedules are created.", +"items": { +"$ref": "Schedule" +}, +"type": "array" +} +}, +"type": "object" +}, "AutomatedBackupPolicy": { "description": "Message describing the user-specified automated backup policy. All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set.", "id": "AutomatedBackupPolicy", @@ -1867,6 +1890,99 @@ false }, "type": "object" }, +"BackupDrBackupSource": { +"description": "Message describing a BackupDrBackupSource.", +"id": "BackupDrBackupSource", +"properties": { +"backup": { +"description": "Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id}", +"type": "string" +} +}, +"type": "object" +}, +"BackupDrEnabledWindow": { +"description": "Information about a single window when BackupDR was enabled for this cluster.", +"id": "BackupDrEnabledWindow", +"properties": { +"automatedBackupPreviouslyEnabled": { +"description": "Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster.", +"type": "boolean" +}, +"backupPlanAssociation": { +"description": "The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster.", +"type": "string" +}, +"continuousBackupPreviousRecoveryWindowDays": { +"description": "The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster.", +"format": "int32", +"type": "integer" +}, +"continuousBackupPreviouslyEnabled": { +"description": "Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster.", +"type": "boolean" +}, +"continuousBackupPreviouslyEnabledTime": { +"description": "The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster.", +"format": "google-datetime", +"type": "string" +}, +"dataSource": { +"description": "The DataSource resource that represents the cluster in BackupDR.", +"type": "string" +}, +"disabledTime": { +"description": "Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`.", +"format": "google-datetime", +"type": "string" +}, +"enabledTime": { +"description": "Time when the BackupDR protection for this cluster was enabled.", +"format": "google-datetime", +"type": "string" +}, +"logRetentionPeriod": { +"description": "The retention period for logs generated by BackupDR for this cluster.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"BackupDrInfo": { +"description": "Information about BackupDR protection for this cluster.", +"id": "BackupDrInfo", +"properties": { +"currentWindow": { +"$ref": "BackupDrEnabledWindow", +"description": "The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty." +}, +"previousWindows": { +"description": "Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list.", +"items": { +"$ref": "BackupDrEnabledWindow" +}, +"type": "array" +} +}, +"type": "object" +}, +"BackupDrPitrSource": { +"description": "Message describing a BackupDrPitrSource.", +"id": "BackupDrPitrSource", +"properties": { +"dataSource": { +"description": "Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}", +"type": "string" +}, +"pointInTime": { +"description": "Required. The point in time to restore to.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "BackupSource": { "description": "Message describing a BackupSource.", "id": "BackupSource", @@ -1975,6 +2091,16 @@ false "description": "Output only. Cluster created from backup.", "readOnly": true }, +"backupdrBackupSource": { +"$ref": "BackupDrBackupSource", +"description": "Output only. Cluster created from a BackupDR backup.", +"readOnly": true +}, +"backupdrInfo": { +"$ref": "BackupDrInfo", +"description": "Output only. Output only information about BackupDR protection for this cluster.", +"readOnly": true +}, "cloudsqlBackupRunSource": { "$ref": "CloudSQLBackupRunSource", "description": "Output only. Cluster created from CloudSQL snapshot.", @@ -2520,6 +2646,18 @@ false }, "type": "object" }, +"CpuUtilization": { +"description": "CPU utilization policy for the autoscaler.", +"id": "CpuUtilization", +"properties": { +"utilizationTarget": { +"description": "Target CPU utilization as a float between 0 and 1.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, "CsvExportOptions": { "description": "Options for exporting data in CSV format.", "id": "CsvExportOptions", @@ -3308,6 +3446,13 @@ false "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -3646,6 +3791,31 @@ false }, "type": "object" }, +"Policy": { +"description": "Policy for the autoscaler.", +"id": "Policy", +"properties": { +"coolDownPeriodSec": { +"description": "The period of time in seconds after a new node is created before the autoscaler will incorporate its resource usage (e.g. CPU utilization) into the autoscaling recommendation algorithm.", +"format": "int64", +"type": "string" +}, +"cpuUtilization": { +"$ref": "CpuUtilization", +"description": "CPU utilization policy for the autoscaler." +}, +"enabled": { +"description": "If true, autoscaling is enabled for the instance. If not set, the default value is false.", +"type": "boolean" +}, +"maxNodeCount": { +"description": "Maximum number of nodes for the autoscaler.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "PrimaryConfig": { "description": "Configuration for the primary cluster. It has the list of clusters that are replicating from this cluster. This should be set if and only if the cluster is of type PRIMARY.", "id": "PrimaryConfig", @@ -3836,6 +4006,10 @@ false "description": "Configuration for a read pool instance.", "id": "ReadPoolConfig", "properties": { +"autoScalingConfig": { +"$ref": "AutoScalingConfig", +"description": "Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled." +}, "nodeCount": { "description": "Read capacity, i.e. number of nodes in a read pool instance.", "format": "int32", @@ -3884,6 +4058,14 @@ false "$ref": "BackupSource", "description": "Backup source." }, +"backupdrBackupSource": { +"$ref": "BackupDrBackupSource", +"description": "BackupDR backup source." +}, +"backupdrPitrSource": { +"$ref": "BackupDrPitrSource", +"description": "BackupDR source used for point in time recovery." +}, "cluster": { "$ref": "Cluster", "description": "Required. The resource being created" @@ -3926,6 +4108,43 @@ false }, "type": "object" }, +"Schedule": { +"description": "A schedule for the autoscaler.", +"id": "Schedule", +"properties": { +"cronExpression": { +"description": "Cron expression for the triggering the schedule. See https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions for the syntax.", +"type": "string" +}, +"description": { +"description": "Description of the schedule.", +"type": "string" +}, +"disabled": { +"description": "If true, the schedule is disabled.", +"type": "boolean" +}, +"durationSec": { +"description": "Duration of the schedule.", +"format": "int64", +"type": "string" +}, +"minNodeCount": { +"description": "Minimum number of nodes in while the schedule is active.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "Name of the schedule.", +"type": "string" +}, +"timeZone": { +"description": "The location-based IANA time zone for interpreting the schedule's start time. If no time zone is provided, UTC is used by default.", +"type": "string" +} +}, +"type": "object" +}, "SecondaryConfig": { "description": "Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY.", "id": "SecondaryConfig", @@ -4075,33 +4294,6 @@ false }, "type": "object" }, -"StageSchedule": { -"description": "Timing information for the stage execution.", -"id": "StageSchedule", -"properties": { -"actualEndTime": { -"description": "Actual end time of the stage. Set only if the stage has completed.", -"format": "google-datetime", -"type": "string" -}, -"actualStartTime": { -"description": "Actual start time of the stage. Set only if the stage has started.", -"format": "google-datetime", -"type": "string" -}, -"estimatedEndTime": { -"description": "When the stage is expected to end. Set only if the stage has not completed yet.", -"format": "google-datetime", -"type": "string" -}, -"estimatedStartTime": { -"description": "When the stage is expected to start. Set only if the stage has not started yet.", -"format": "google-datetime", -"type": "string" -} -}, -"type": "object" -}, "StageStatus": { "description": "Status of an upgrade stage.", "id": "StageStatus", @@ -4110,11 +4302,6 @@ false "$ref": "ReadPoolInstancesUpgradeStageStatus", "description": "Read pool instances upgrade metadata." }, -"schedule": { -"$ref": "StageSchedule", -"description": "Output only. Timing information for the stage execution.", -"readOnly": true -}, "stage": { "description": "Upgrade stage.", "enum": [ @@ -4986,7 +5173,7 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { -"description": "Common model for database resource instance metadata. Next ID: 27", +"description": "Common model for database resource instance metadata. Next ID: 29", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -5137,6 +5324,10 @@ false "$ref": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", "description": "Machine configuration for this resource." }, +"maintenanceInfo": { +"$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo", +"description": "Optional. Maintenance info for the resource." +}, "primaryResourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." @@ -5842,6 +6033,100 @@ false }, "type": "object" }, +"StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule": { +"description": "Deny maintenance period for the database resource. It specifies the time range during which the maintenance cannot start. This is configured by the customer.", +"id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule", +"properties": { +"endDate": { +"$ref": "GoogleTypeDate", +"description": "Optional. Deny period end date." +}, +"startDate": { +"$ref": "GoogleTypeDate", +"description": "Optional. The start date of the deny maintenance period." +}, +"time": { +"$ref": "GoogleTypeTimeOfDay", +"description": "Optional. Time in UTC when the deny period starts on start_date and ends on end_date." +} +}, +"type": "object" +}, +"StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo": { +"description": "MaintenanceInfo to capture the maintenance details of database resource.", +"id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo", +"properties": { +"denyMaintenanceSchedules": { +"description": "Optional. List of Deny maintenance period for the database resource.", +"items": { +"$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule" +}, +"type": "array" +}, +"maintenanceSchedule": { +"$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule", +"description": "Optional. Maintenance window for the database resource." +}, +"maintenanceVersion": { +"description": "Optional. Current Maintenance version of the database resource. Example: \"MYSQL_8_0_41.R20250531.01_15\"", +"type": "string" +} +}, +"type": "object" +}, +"StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule": { +"description": "Maintenance window for the database resource. It specifies preferred time and day of the week and phase in some cases, when the maintenance can start. This is configured by the customer.", +"id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule", +"properties": { +"day": { +"description": "Optional. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.", +"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" +}, +"phase": { +"description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance", +"enum": [ +"WINDOW_PHASE_UNSPECIFIED", +"WINDOW_PHASE_ANY", +"WINDOW_PHASE_WEEK1", +"WINDOW_PHASE_WEEK2", +"WINDOW_PHASE_WEEK5" +], +"enumDescriptions": [ +"Phase is unspecified.", +"Any phase.", +"Week 1.", +"Week 2.", +"Week 5." +], +"type": "string" +}, +"time": { +"$ref": "GoogleTypeTimeOfDay", +"description": "Optional. Preferred time to start the maintenance operation on the specified day." +} +}, +"type": "object" +}, "StorageDatabasecenterPartnerapiV1mainRetentionSettings": { "id": "StorageDatabasecenterPartnerapiV1mainRetentionSettings", "properties": { diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json index 83f522a064..e5c4a185b8 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json @@ -1547,6 +1547,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -1619,7 +1624,7 @@ } } }, -"revision": "20250910", +"revision": "20250925", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1633,6 +1638,24 @@ }, "type": "object" }, +"AutoScalingConfig": { +"description": "Configuration for autoscaling.", +"id": "AutoScalingConfig", +"properties": { +"policy": { +"$ref": "Policy", +"description": "Policy for the MIG autoscaler." +}, +"schedules": { +"description": "Optional list of schedules for the MIG autoscaler. If not set, no schedules are created.", +"items": { +"$ref": "Schedule" +}, +"type": "array" +} +}, +"type": "object" +}, "AutomatedBackupPolicy": { "description": "Message describing the user-specified automated backup policy. All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set.", "id": "AutomatedBackupPolicy", @@ -1859,6 +1882,99 @@ false }, "type": "object" }, +"BackupDrBackupSource": { +"description": "Message describing a BackupDrBackupSource.", +"id": "BackupDrBackupSource", +"properties": { +"backup": { +"description": "Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id}", +"type": "string" +} +}, +"type": "object" +}, +"BackupDrEnabledWindow": { +"description": "Information about a single window when BackupDR was enabled for this cluster.", +"id": "BackupDrEnabledWindow", +"properties": { +"automatedBackupPreviouslyEnabled": { +"description": "Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster.", +"type": "boolean" +}, +"backupPlanAssociation": { +"description": "The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster.", +"type": "string" +}, +"continuousBackupPreviousRecoveryWindowDays": { +"description": "The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster.", +"format": "int32", +"type": "integer" +}, +"continuousBackupPreviouslyEnabled": { +"description": "Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster.", +"type": "boolean" +}, +"continuousBackupPreviouslyEnabledTime": { +"description": "The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster.", +"format": "google-datetime", +"type": "string" +}, +"dataSource": { +"description": "The DataSource resource that represents the cluster in BackupDR.", +"type": "string" +}, +"disabledTime": { +"description": "Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`.", +"format": "google-datetime", +"type": "string" +}, +"enabledTime": { +"description": "Time when the BackupDR protection for this cluster was enabled.", +"format": "google-datetime", +"type": "string" +}, +"logRetentionPeriod": { +"description": "The retention period for logs generated by BackupDR for this cluster.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"BackupDrInfo": { +"description": "Information about BackupDR protection for this cluster.", +"id": "BackupDrInfo", +"properties": { +"currentWindow": { +"$ref": "BackupDrEnabledWindow", +"description": "The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty." +}, +"previousWindows": { +"description": "Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list.", +"items": { +"$ref": "BackupDrEnabledWindow" +}, +"type": "array" +} +}, +"type": "object" +}, +"BackupDrPitrSource": { +"description": "Message describing a BackupDrPitrSource.", +"id": "BackupDrPitrSource", +"properties": { +"dataSource": { +"description": "Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}", +"type": "string" +}, +"pointInTime": { +"description": "Required. The point in time to restore to.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "BackupSource": { "description": "Message describing a BackupSource.", "id": "BackupSource", @@ -1961,6 +2077,16 @@ false "description": "Output only. Cluster created from backup.", "readOnly": true }, +"backupdrBackupSource": { +"$ref": "BackupDrBackupSource", +"description": "Output only. Cluster created from a BackupDR backup.", +"readOnly": true +}, +"backupdrInfo": { +"$ref": "BackupDrInfo", +"description": "Output only. Output only information about BackupDR protection for this cluster.", +"readOnly": true +}, "cloudsqlBackupRunSource": { "$ref": "CloudSQLBackupRunSource", "description": "Output only. Cluster created from CloudSQL snapshot.", @@ -2501,6 +2627,18 @@ false }, "type": "object" }, +"CpuUtilization": { +"description": "CPU utilization policy for the autoscaler.", +"id": "CpuUtilization", +"properties": { +"utilizationTarget": { +"description": "Target CPU utilization as a float between 0 and 1.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, "CsvExportOptions": { "description": "Options for exporting data in CSV format.", "id": "CsvExportOptions", @@ -3284,6 +3422,13 @@ false "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -3622,6 +3767,31 @@ false }, "type": "object" }, +"Policy": { +"description": "Policy for the autoscaler.", +"id": "Policy", +"properties": { +"coolDownPeriodSec": { +"description": "The period of time in seconds after a new node is created before the autoscaler will incorporate its resource usage (e.g. CPU utilization) into the autoscaling recommendation algorithm.", +"format": "int64", +"type": "string" +}, +"cpuUtilization": { +"$ref": "CpuUtilization", +"description": "CPU utilization policy for the autoscaler." +}, +"enabled": { +"description": "If true, autoscaling is enabled for the instance. If not set, the default value is false.", +"type": "boolean" +}, +"maxNodeCount": { +"description": "Maximum number of nodes for the autoscaler.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "PrimaryConfig": { "description": "Configuration for the primary cluster. It has the list of clusters that are replicating from this cluster. This should be set if and only if the cluster is of type PRIMARY.", "id": "PrimaryConfig", @@ -3812,6 +3982,10 @@ false "description": "Configuration for a read pool instance.", "id": "ReadPoolConfig", "properties": { +"autoScalingConfig": { +"$ref": "AutoScalingConfig", +"description": "Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled." +}, "nodeCount": { "description": "Read capacity, i.e. number of nodes in a read pool instance.", "format": "int32", @@ -3860,6 +4034,14 @@ false "$ref": "BackupSource", "description": "Backup source." }, +"backupdrBackupSource": { +"$ref": "BackupDrBackupSource", +"description": "BackupDR backup source." +}, +"backupdrPitrSource": { +"$ref": "BackupDrPitrSource", +"description": "BackupDR source used for point in time recovery." +}, "cluster": { "$ref": "Cluster", "description": "Required. The resource being created" @@ -3902,6 +4084,43 @@ false }, "type": "object" }, +"Schedule": { +"description": "A schedule for the autoscaler.", +"id": "Schedule", +"properties": { +"cronExpression": { +"description": "Cron expression for the triggering the schedule. See https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions for the syntax.", +"type": "string" +}, +"description": { +"description": "Description of the schedule.", +"type": "string" +}, +"disabled": { +"description": "If true, the schedule is disabled.", +"type": "boolean" +}, +"durationSec": { +"description": "Duration of the schedule.", +"format": "int64", +"type": "string" +}, +"minNodeCount": { +"description": "Minimum number of nodes in while the schedule is active.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "Name of the schedule.", +"type": "string" +}, +"timeZone": { +"description": "The location-based IANA time zone for interpreting the schedule's start time. If no time zone is provided, UTC is used by default.", +"type": "string" +} +}, +"type": "object" +}, "SecondaryConfig": { "description": "Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY.", "id": "SecondaryConfig", @@ -4051,33 +4270,6 @@ false }, "type": "object" }, -"StageSchedule": { -"description": "Timing information for the stage execution.", -"id": "StageSchedule", -"properties": { -"actualEndTime": { -"description": "Actual end time of the stage. Set only if the stage has completed.", -"format": "google-datetime", -"type": "string" -}, -"actualStartTime": { -"description": "Actual start time of the stage. Set only if the stage has started.", -"format": "google-datetime", -"type": "string" -}, -"estimatedEndTime": { -"description": "When the stage is expected to end. Set only if the stage has not completed yet.", -"format": "google-datetime", -"type": "string" -}, -"estimatedStartTime": { -"description": "When the stage is expected to start. Set only if the stage has not started yet.", -"format": "google-datetime", -"type": "string" -} -}, -"type": "object" -}, "StageStatus": { "description": "Status of an upgrade stage.", "id": "StageStatus", @@ -4086,11 +4278,6 @@ false "$ref": "ReadPoolInstancesUpgradeStageStatus", "description": "Read pool instances upgrade metadata." }, -"schedule": { -"$ref": "StageSchedule", -"description": "Output only. Timing information for the stage execution.", -"readOnly": true -}, "stage": { "description": "Upgrade stage.", "enum": [ @@ -4962,7 +5149,7 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { -"description": "Common model for database resource instance metadata. Next ID: 27", +"description": "Common model for database resource instance metadata. Next ID: 29", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -5113,6 +5300,10 @@ false "$ref": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", "description": "Machine configuration for this resource." }, +"maintenanceInfo": { +"$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo", +"description": "Optional. Maintenance info for the resource." +}, "primaryResourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." @@ -5818,6 +6009,100 @@ false }, "type": "object" }, +"StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule": { +"description": "Deny maintenance period for the database resource. It specifies the time range during which the maintenance cannot start. This is configured by the customer.", +"id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule", +"properties": { +"endDate": { +"$ref": "GoogleTypeDate", +"description": "Optional. Deny period end date." +}, +"startDate": { +"$ref": "GoogleTypeDate", +"description": "Optional. The start date of the deny maintenance period." +}, +"time": { +"$ref": "GoogleTypeTimeOfDay", +"description": "Optional. Time in UTC when the deny period starts on start_date and ends on end_date." +} +}, +"type": "object" +}, +"StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo": { +"description": "MaintenanceInfo to capture the maintenance details of database resource.", +"id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo", +"properties": { +"denyMaintenanceSchedules": { +"description": "Optional. List of Deny maintenance period for the database resource.", +"items": { +"$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule" +}, +"type": "array" +}, +"maintenanceSchedule": { +"$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule", +"description": "Optional. Maintenance window for the database resource." +}, +"maintenanceVersion": { +"description": "Optional. Current Maintenance version of the database resource. Example: \"MYSQL_8_0_41.R20250531.01_15\"", +"type": "string" +} +}, +"type": "object" +}, +"StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule": { +"description": "Maintenance window for the database resource. It specifies preferred time and day of the week and phase in some cases, when the maintenance can start. This is configured by the customer.", +"id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule", +"properties": { +"day": { +"description": "Optional. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.", +"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" +}, +"phase": { +"description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance", +"enum": [ +"WINDOW_PHASE_UNSPECIFIED", +"WINDOW_PHASE_ANY", +"WINDOW_PHASE_WEEK1", +"WINDOW_PHASE_WEEK2", +"WINDOW_PHASE_WEEK5" +], +"enumDescriptions": [ +"Phase is unspecified.", +"Any phase.", +"Week 1.", +"Week 2.", +"Week 5." +], +"type": "string" +}, +"time": { +"$ref": "GoogleTypeTimeOfDay", +"description": "Optional. Preferred time to start the maintenance operation on the specified day." +} +}, +"type": "object" +}, "StorageDatabasecenterPartnerapiV1mainRetentionSettings": { "id": "StorageDatabasecenterPartnerapiV1mainRetentionSettings", "properties": { diff --git a/googleapiclient/discovery_cache/documents/apigee.v1.json b/googleapiclient/discovery_cache/documents/apigee.v1.json index ab38b613ba..5178b24f7a 100644 --- a/googleapiclient/discovery_cache/documents/apigee.v1.json +++ b/googleapiclient/discovery_cache/documents/apigee.v1.json @@ -9309,6 +9309,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -11284,7 +11289,7 @@ } } }, -"revision": "20250908", +"revision": "20250929", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -11901,12 +11906,14 @@ "enum": [ "QUOTA_COUNTER_SCOPE_UNSPECIFIED", "PROXY", -"OPERATION" +"OPERATION", +"PRODUCT" ], "enumDescriptions": [ "When quota is not explicitly defined for each operation(REST/GraphQL), the limits set at product level will be used as a local counter for quota evaluation by all the operations, independent of proxy association.", "When quota is not explicitly defined for each operation(REST/GraphQL), set at product level will be used as a global counter for quota evaluation by all the operations associated with a particular proxy.", -"When quota is not explicitly defined for each operation(REST/GraphQL), the limits set at product level will be used as a local counter for quota evaluation by all the operations, independent of proxy association. This behavior mimics the same as QUOTA_COUNTER_SCOPE_UNSPECIFIED." +"When quota is not explicitly defined for each operation(REST/GraphQL), the limits set at product level will be used as a local counter for quota evaluation by all the operations, independent of proxy association. This behavior mimics the same as QUOTA_COUNTER_SCOPE_UNSPECIFIED.", +"When quota is not explicitly defined for each operation(REST/GraphQL), the limits set at product level will be used as a global counter for quota evaluation by all the operations." ], "type": "string" }, @@ -15194,6 +15201,11 @@ "description": "Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or `a.b.c.d/22,e.f.g.h/28`", "type": "string" }, +"isVersionLocked": { +"description": "Output only. Indicates whether the instance is version locked. If true, the instance will not be updated by automated runtime rollouts. This is only supported for Apigee X instances.", +"readOnly": true, +"type": "boolean" +}, "lastModifiedAt": { "description": "Output only. Time the instance was last modified in milliseconds since epoch.", "format": "int64", @@ -15204,6 +15216,10 @@ "description": "Required. Compute Engine location where the instance resides.", "type": "string" }, +"maintenanceUpdatePolicy": { +"$ref": "GoogleCloudApigeeV1MaintenanceUpdatePolicy", +"description": "Optional. Apigee customers can set the preferred window to perform maintenance on the instance (day of the week and time of day)." +}, "name": { "description": "Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\\d]$`.", "type": "string" @@ -15243,6 +15259,11 @@ "readOnly": true, "type": "string" }, +"scheduledMaintenance": { +"$ref": "GoogleCloudApigeeV1ScheduledMaintenance", +"description": "Output only. Time and date of the scheduled maintenance for this instance. This field is only populated for instances that have opted into Maintenance Window and if there is an upcoming maintenance. Cleared once the maintenance is complete.", +"readOnly": true +}, "serviceAttachment": { "description": "Output only. Resource name of the service attachment created for the instance in the format: `projects/*/regions/*/serviceAttachments/*` Apigee customers can privately forward traffic to this service attachment using the PSC endpoints.", "readOnly": true, @@ -16175,6 +16196,69 @@ }, "type": "object" }, +"GoogleCloudApigeeV1MaintenanceUpdatePolicy": { +"description": "MaintenanceUpdatePolicy specifies the preferred window to perform maintenance on the instance (day of the week and time of day).", +"id": "GoogleCloudApigeeV1MaintenanceUpdatePolicy", +"properties": { +"maintenanceChannel": { +"description": "Optional. Maintenance channel to specify relative scheduling for maintenance.", +"enum": [ +"MAINTENANCE_CHANNEL_UNSPECIFIED", +"WEEK1", +"WEEK2" +], +"enumDescriptions": [ +"Unspecified maintenance channel.", +"Receive 1 weeks notice before maintenance occurs", +"Receive 2 weeks notice before maintenance occurs" +], +"type": "string" +}, +"maintenanceWindows": { +"description": "Optional. Preferred windows to perform maintenance. Currently limited to 1.", +"items": { +"$ref": "GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow": { +"description": "MaintenanceWindow specifies the preferred day of the week and time of day to perform maintenance.", +"id": "GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow", +"properties": { +"day": { +"description": "Required. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.", +"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" +}, +"startTime": { +"$ref": "GoogleTypeTimeOfDay", +"description": "Required. The start time (UTC) of the maintenance window." +} +}, +"type": "object" +}, "GoogleCloudApigeeV1Metadata": { "description": "Encapsulates additional information about query execution.", "id": "GoogleCloudApigeeV1Metadata", @@ -18007,6 +18091,19 @@ }, "type": "object" }, +"GoogleCloudApigeeV1ScheduledMaintenance": { +"description": "Scheduled maintenance information for an instance.", +"id": "GoogleCloudApigeeV1ScheduledMaintenance", +"properties": { +"startTime": { +"description": "Output only. The start time (UTC) of the scheduled maintenance.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudApigeeV1Schema": { "description": "Response for Schema call", "id": "GoogleCloudApigeeV1Schema", @@ -20132,6 +20229,13 @@ "$ref": "GoogleLongrunningOperation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -20297,6 +20401,33 @@ } }, "type": "object" +}, +"GoogleTypeTimeOfDay": { +"description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", +"id": "GoogleTypeTimeOfDay", +"properties": { +"hours": { +"description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", +"format": "int32", +"type": "integer" +}, +"minutes": { +"description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", +"format": "int32", +"type": "integer" +}, +"nanos": { +"description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", +"format": "int32", +"type": "integer" +}, +"seconds": { +"description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/apim.v1alpha.json b/googleapiclient/discovery_cache/documents/apim.v1alpha.json index a3e052e5e2..5868530bf7 100644 --- a/googleapiclient/discovery_cache/documents/apim.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/apim.v1alpha.json @@ -829,6 +829,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -846,7 +851,7 @@ } } }, -"revision": "20250910", +"revision": "20250924", "rootUrl": "https://apim.googleapis.com/", "schemas": { "ApiObservation": { @@ -1419,6 +1424,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/appengine.v1.json b/googleapiclient/discovery_cache/documents/appengine.v1.json index 2752876005..5472362a87 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1.json @@ -959,7 +959,7 @@ "type": "string" }, "extraLocationTypes": { -"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1058,6 +1058,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/apps/{appsId}/operations", @@ -2092,6 +2097,51 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"delete": { +"description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}", +"httpMethod": "DELETE", +"id": "appengine.projects.locations.applications.domainMappings.delete", +"parameterOrder": [ +"projectsId", +"locationsId", +"applicationsId", +"domainMappingsId" +], +"parameters": { +"applicationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"domainMappingsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"locationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"projectsId": { +"description": "Part of `name`. Required. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets the specified domain mapping.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}", @@ -2138,6 +2188,60 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] +}, +"patch": { +"description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}", +"httpMethod": "PATCH", +"id": "appengine.projects.locations.applications.domainMappings.patch", +"parameterOrder": [ +"projectsId", +"locationsId", +"applicationsId", +"domainMappingsId" +], +"parameters": { +"applicationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"domainMappingsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"locationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"projectsId": { +"description": "Part of `name`. Required. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.", +"location": "path", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Standard field mask for the set of fields to be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}", +"request": { +"$ref": "DomainMapping" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -2375,7 +2479,7 @@ } } }, -"revision": "20250816", +"revision": "20250930", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -3512,6 +3616,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/appengine.v1alpha.json b/googleapiclient/discovery_cache/documents/appengine.v1alpha.json index 4680c89872..31f958117a 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1alpha.json @@ -599,7 +599,7 @@ "type": "string" }, "extraLocationTypes": { -"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -698,6 +698,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1alpha/apps/{appsId}/operations", @@ -761,7 +766,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1189,6 +1194,51 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"delete": { +"description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}", +"httpMethod": "DELETE", +"id": "appengine.projects.locations.applications.domainMappings.delete", +"parameterOrder": [ +"projectsId", +"locationsId", +"applicationsId", +"domainMappingsId" +], +"parameters": { +"applicationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"domainMappingsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"locationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"projectsId": { +"description": "Part of `name`. Required. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets the specified domain mapping.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}", @@ -1235,6 +1285,65 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] +}, +"patch": { +"description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}", +"httpMethod": "PATCH", +"id": "appengine.projects.locations.applications.domainMappings.patch", +"parameterOrder": [ +"projectsId", +"locationsId", +"applicationsId", +"domainMappingsId" +], +"parameters": { +"applicationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"domainMappingsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"locationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"noManagedCertificate": { +"description": "Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated. Only applicable if ssl_settings.certificate_id is specified in the update mask.", +"location": "query", +"type": "boolean" +}, +"projectsId": { +"description": "Part of `name`. Required. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.", +"location": "path", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Standard field mask for the set of fields to be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}", +"request": { +"$ref": "DomainMapping" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } } @@ -1319,6 +1428,11 @@ "location": "path", "required": true, "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations", @@ -1338,7 +1452,7 @@ } } }, -"revision": "20250816", +"revision": "20250930", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "AuthorizedCertificate": { @@ -1641,6 +1755,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/appengine.v1beta.json b/googleapiclient/discovery_cache/documents/appengine.v1beta.json index 6323e11611..0603f6ce65 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1beta.json @@ -959,7 +959,7 @@ "type": "string" }, "extraLocationTypes": { -"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1058,6 +1058,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta/apps/{appsId}/operations", @@ -1733,7 +1738,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2205,6 +2210,51 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"delete": { +"description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}", +"httpMethod": "DELETE", +"id": "appengine.projects.locations.applications.domainMappings.delete", +"parameterOrder": [ +"projectsId", +"locationsId", +"applicationsId", +"domainMappingsId" +], +"parameters": { +"applicationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"domainMappingsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"locationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"projectsId": { +"description": "Part of `name`. Required. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets the specified domain mapping.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}", @@ -2251,6 +2301,60 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] +}, +"patch": { +"description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}", +"httpMethod": "PATCH", +"id": "appengine.projects.locations.applications.domainMappings.patch", +"parameterOrder": [ +"projectsId", +"locationsId", +"applicationsId", +"domainMappingsId" +], +"parameters": { +"applicationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"domainMappingsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"locationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"projectsId": { +"description": "Part of `name`. Required. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.", +"location": "path", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Standard field mask for the set of fields to be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}", +"request": { +"$ref": "DomainMapping" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -2562,6 +2666,11 @@ "location": "path", "required": true, "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta/projects/{projectsId}/locations/{locationsId}/operations", @@ -2581,7 +2690,7 @@ } } }, -"revision": "20250816", +"revision": "20250930", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -3769,6 +3878,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json index 08bf842331..5309ddb660 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json @@ -473,7 +473,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2465,7 +2465,7 @@ } } }, -"revision": "20250704", +"revision": "20250925", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json index c73c35477a..cd35a5e1e9 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json @@ -447,7 +447,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1450,7 +1450,7 @@ } } }, -"revision": "20250704", +"revision": "20250925", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index f6eb1ca64e..8d05d006b0 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -2375,7 +2375,7 @@ } } }, -"revision": "20250919", +"revision": "20250928", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -4639,6 +4639,14 @@ "timestampFormat": { "description": "Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values.", "type": "string" +}, +"timestampTargetPrecision": { +"description": "Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated.", +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" } }, "type": "object" @@ -5512,7 +5520,7 @@ "description": "[Pick one] Configures a load job." }, "maxSlots": { -"description": "Optional. INTERNAL: DO NOT USE. The maximum rate of slot consumption to allow for this job. If set, the number of slots used to execute the job will be throttled to try and keep its slot consumption below the requested rate.", +"description": "Optional. A target limit on the rate of slot consumption by this job. If set to a value > 0, BigQuery will attempt to limit the rate of slot consumption by this job to keep it below the configured limit, even if the job is eligible for more slots based on fair scheduling. The unused slots will be available for other jobs and queries to use. Note: This feature is not yet generally available.", "format": "int32", "type": "integer" }, @@ -5822,6 +5830,14 @@ "description": "Optional. Date format used for parsing TIMESTAMP values.", "type": "string" }, +"timestampTargetPrecision": { +"description": "Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated.", +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, "useAvroLogicalTypes": { "description": "Optional. If sourceFormat is set to \"AVRO\", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).", "type": "boolean" @@ -6244,6 +6260,14 @@ "readOnly": true, "type": "array" }, +"reservationGroupPath": { +"description": "Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservatins info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "reservationUsage": { "deprecated": true, "description": "Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated.", @@ -7877,7 +7901,7 @@ "type": "integer" }, "maxSlots": { -"description": "Optional. INTERNAL: DO NOT USE. The maximum rate of slot consumption to allow for this job. If set, the number of slots used to execute the job will be throttled to try and keep its slot consumption below the requested rate. This limit is best effort.", +"description": "Optional. A target limit on the rate of slot consumption by this query. If set to a value > 0, BigQuery will attempt to limit the rate of slot consumption by this query to keep it below the configured limit, even if the query is eligible for more slots based on fair scheduling. The unused slots will be available for other jobs and queries to use. Note: This feature is not yet generally available.", "format": "int32", "type": "integer" }, diff --git a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json index e3eb1fa648..704bf9fbe4 100644 --- a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json +++ b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json @@ -1131,6 +1131,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1320,7 +1325,7 @@ } } }, -"revision": "20250917", +"revision": "20250924", "rootUrl": "https://certificatemanager.googleapis.com/", "schemas": { "AllowlistedCertificate": { @@ -2040,6 +2045,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index 4482233487..713218c8a4 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -23,6 +23,9 @@ "https://www.googleapis.com/auth/chat.app.memberships": { "description": "On their own behalf, apps in Google Chat can see, add, update, and remove members from conversations and spaces" }, +"https://www.googleapis.com/auth/chat.app.messages.readonly": { +"description": "On their own behalf, apps in Google Chat can see all messages and their associated reactions and message content" +}, "https://www.googleapis.com/auth/chat.app.spaces": { "description": "On their own behalf, apps in Google Chat can create conversations and spaces and see or update their metadata (including history settings and access settings)" }, @@ -995,6 +998,7 @@ "$ref": "Message" }, "scopes": [ +"https://www.googleapis.com/auth/chat.app.messages.readonly", "https://www.googleapis.com/auth/chat.bot", "https://www.googleapis.com/auth/chat.messages", "https://www.googleapis.com/auth/chat.messages.readonly" @@ -1048,6 +1052,7 @@ "$ref": "ListMessagesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/chat.app.messages.readonly", "https://www.googleapis.com/auth/chat.import", "https://www.googleapis.com/auth/chat.messages", "https://www.googleapis.com/auth/chat.messages.readonly" @@ -1299,6 +1304,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/chat.app.memberships", +"https://www.googleapis.com/auth/chat.app.messages.readonly", "https://www.googleapis.com/auth/chat.app.spaces", "https://www.googleapis.com/auth/chat.memberships", "https://www.googleapis.com/auth/chat.memberships.readonly", @@ -1349,6 +1355,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/chat.app.memberships", +"https://www.googleapis.com/auth/chat.app.messages.readonly", "https://www.googleapis.com/auth/chat.app.spaces", "https://www.googleapis.com/auth/chat.memberships", "https://www.googleapis.com/auth/chat.memberships.readonly", @@ -1528,7 +1535,7 @@ } } }, -"revision": "20250923", +"revision": "20250930", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -4491,8 +4498,8 @@ ], "enumDescriptions": [ "Default value. For users: they aren't a member of the space, but can be invited. For Google Groups: they're always assigned this role (other enum values might be used in the future).", -"A member of the space. The user has basic permissions, like sending messages to the space. In 1:1 and unnamed group conversations, everyone has this role.", -"A space manager. The user has all basic permissions plus administrative permissions that let them manage the space, like adding or removing members. Only supported in SpaceType.SPACE." +"A member of the space. In the Chat UI, this role is called Member. The user has basic permissions, like sending messages to the space. Managers and owners can grant members additional permissions in a space, including: - Add or remove members. - Modify space details. - Turn history on or off. - Mention everyone in the space with `@all`. - Manage Chat apps and webhooks installed in the space. In direct messages and unnamed group conversations, everyone has this role.", +"A space owner. In the Chat UI, this role is called Owner. The user has the complete set of space permissions to manage the space, including: - Change the role of other members in the space to member, manager, or owner. - Delete the space. Only supported in SpaceType.SPACE (named spaces). To learn more, see [Learn more about your role as a space owner or manager](https://support.google.com/chat/answer/11833441)." ], "type": "string" }, @@ -4865,11 +4872,11 @@ "id": "PermissionSetting", "properties": { "managersAllowed": { -"description": "Optional. Whether spaces managers have this permission.", +"description": "Optional. Whether space owners (`ROLE_MANAGER`) have this permission.", "type": "boolean" }, "membersAllowed": { -"description": "Optional. Whether non-manager members have this permission.", +"description": "Optional. Whether basic space members (`ROLE_MEMBER`) have this permission.", "type": "boolean" } }, diff --git a/googleapiclient/discovery_cache/documents/classroom.v1.json b/googleapiclient/discovery_cache/documents/classroom.v1.json index c6f0718610..dc024efcae 100644 --- a/googleapiclient/discovery_cache/documents/classroom.v1.json +++ b/googleapiclient/discovery_cache/documents/classroom.v1.json @@ -4107,7 +4107,7 @@ } } }, -"revision": "20250827", +"revision": "20250929", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "AddOnAttachment": { @@ -4464,7 +4464,7 @@ }, "gradebookSettings": { "$ref": "GradebookSettings", -"description": "The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only" +"description": "The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only." }, "guardiansEnabled": { "description": "Whether or not guardian notifications are enabled for this course. Read-only.", diff --git a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json index 2850c4c01e..68006bd2ca 100644 --- a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json @@ -2183,6 +2183,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}", @@ -2289,7 +2294,7 @@ } } }, -"revision": "20250809", +"revision": "20250929", "rootUrl": "https://cloudchannel.googleapis.com/", "schemas": { "GoogleCloudChannelV1ActivateEntitlementRequest": { @@ -5851,6 +5856,13 @@ false "$ref": "GoogleLongrunningOperation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json index 8ae2fba759..806673c77d 100644 --- a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json +++ b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json @@ -2038,6 +2038,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -2354,7 +2359,7 @@ } } }, -"revision": "20250910", +"revision": "20250924", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { @@ -4613,6 +4618,13 @@ true "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json index 134cdc8a9c..fada2227da 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json @@ -159,6 +159,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/operations", @@ -558,7 +563,7 @@ } } }, -"revision": "20250908", +"revision": "20250929", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -1087,6 +1092,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json index 5bd25d29fa..2e5c997898 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json @@ -699,6 +699,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2/{+name}/operations", @@ -750,7 +755,7 @@ } } }, -"revision": "20250908", +"revision": "20250929", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -1484,6 +1489,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json index 9ed71c2755..bb6e13e083 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json @@ -699,6 +699,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2alpha/{+name}/operations", @@ -750,7 +755,7 @@ } } }, -"revision": "20250908", +"revision": "20250929", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -1484,6 +1489,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json index 5bc7cd6703..bca7ddc4a8 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json @@ -699,6 +699,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2beta/{+name}/operations", @@ -750,7 +755,7 @@ } } }, -"revision": "20250908", +"revision": "20250929", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -1484,6 +1489,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/cloudkms.v1.json b/googleapiclient/discovery_cache/documents/cloudkms.v1.json index 13ec9ce0d4..5a2900cd41 100644 --- a/googleapiclient/discovery_cache/documents/cloudkms.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudkms.v1.json @@ -229,7 +229,7 @@ ] }, "getKajPolicyConfig": { -"description": "Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.", +"description": "Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.", "flatPath": "v1/folders/{foldersId}/kajPolicyConfig", "httpMethod": "GET", "id": "cloudkms.folders.getKajPolicyConfig", @@ -290,7 +290,7 @@ ] }, "updateKajPolicyConfig": { -"description": "Updates the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.", +"description": "Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.", "flatPath": "v1/folders/{foldersId}/kajPolicyConfig", "httpMethod": "PATCH", "id": "cloudkms.folders.updateKajPolicyConfig", @@ -329,7 +329,7 @@ "organizations": { "methods": { "getKajPolicyConfig": { -"description": "Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.", +"description": "Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.", "flatPath": "v1/organizations/{organizationsId}/kajPolicyConfig", "httpMethod": "GET", "id": "cloudkms.organizations.getKajPolicyConfig", @@ -355,7 +355,7 @@ ] }, "updateKajPolicyConfig": { -"description": "Updates the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.", +"description": "Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.", "flatPath": "v1/organizations/{organizationsId}/kajPolicyConfig", "httpMethod": "PATCH", "id": "cloudkms.organizations.updateKajPolicyConfig", @@ -420,7 +420,7 @@ ] }, "getKajPolicyConfig": { -"description": "Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.", +"description": "Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.", "flatPath": "v1/projects/{projectsId}/kajPolicyConfig", "httpMethod": "GET", "id": "cloudkms.projects.getKajPolicyConfig", @@ -559,7 +559,7 @@ ] }, "updateKajPolicyConfig": { -"description": "Updates the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.", +"description": "Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.", "flatPath": "v1/projects/{projectsId}/kajPolicyConfig", "httpMethod": "PATCH", "id": "cloudkms.projects.updateKajPolicyConfig", @@ -2496,7 +2496,7 @@ } } }, -"revision": "20250911", +"revision": "20250926", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AsymmetricDecryptRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json b/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json index 524bbfdefd..eb07eb58cb 100644 --- a/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json @@ -530,6 +530,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -547,7 +552,7 @@ } } }, -"revision": "20250917", +"revision": "20250925", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": { @@ -832,6 +837,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/cloudshell.v1.json b/googleapiclient/discovery_cache/documents/cloudshell.v1.json index 529edf2bca..0db23cfe84 100644 --- a/googleapiclient/discovery_cache/documents/cloudshell.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudshell.v1.json @@ -216,6 +216,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}", @@ -374,7 +379,7 @@ } } }, -"revision": "20241118", +"revision": "20250930", "rootUrl": "https://cloudshell.googleapis.com/", "schemas": { "AddPublicKeyMetadata": { @@ -543,6 +548,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/composer.v1.json b/googleapiclient/discovery_cache/documents/composer.v1.json index 11725b1904..cab90d79ea 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1.json @@ -1209,6 +1209,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1226,7 +1231,7 @@ } } }, -"revision": "20250803", +"revision": "20250928", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { @@ -1290,6 +1295,14 @@ "readOnly": true, "type": "string" }, +"configConflicts": { +"description": "Output only. Contains information about environment configuration that is incompatible with the new image version, except for pypi modules conflicts.", +"items": { +"$ref": "ConfigConflict" +}, +"readOnly": true, +"type": "array" +}, "containsPypiModulesConflict": { "description": "Output only. Whether build has succeeded or failed on modules conflicts.", "enum": [ @@ -1432,6 +1445,31 @@ }, "type": "object" }, +"ConfigConflict": { +"description": "Environment configuration conflict.", +"id": "ConfigConflict", +"properties": { +"message": { +"description": "Conflict message.", +"type": "string" +}, +"type": { +"description": "Conflict type. It can be blocking or non-blocking.", +"enum": [ +"CONFLICT_TYPE_UNSPECIFIED", +"BLOCKING", +"NON_BLOCKING" +], +"enumDescriptions": [ +"Conflict type is unknown.", +"Conflict is blocking, the upgrade would fail.", +"Conflict is non-blocking. The upgrade would succeed, but the environment configuration would be changed." +], +"type": "string" +} +}, +"type": "object" +}, "DagProcessorResource": { "description": "Configuration for resources used by Airflow DAG processors. This field is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer.", "id": "DagProcessorResource", @@ -1922,6 +1960,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/composer.v1beta1.json b/googleapiclient/discovery_cache/documents/composer.v1beta1.json index aa63b2029d..cea07f75ef 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1beta1.json @@ -1209,6 +1209,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -1226,7 +1231,7 @@ } } }, -"revision": "20250803", +"revision": "20250928", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { @@ -1290,6 +1295,14 @@ "readOnly": true, "type": "string" }, +"configConflicts": { +"description": "Output only. Contains information about environment configuration that is incompatible with the new image version, except for pypi modules conflicts.", +"items": { +"$ref": "ConfigConflict" +}, +"readOnly": true, +"type": "array" +}, "containsPypiModulesConflict": { "description": "Output only. Whether build has succeeded or failed on modules conflicts.", "enum": [ @@ -1432,6 +1445,31 @@ }, "type": "object" }, +"ConfigConflict": { +"description": "Environment configuration conflict.", +"id": "ConfigConflict", +"properties": { +"message": { +"description": "Conflict message.", +"type": "string" +}, +"type": { +"description": "Conflict type. It can be blocking or non-blocking.", +"enum": [ +"CONFLICT_TYPE_UNSPECIFIED", +"BLOCKING", +"NON_BLOCKING" +], +"enumDescriptions": [ +"Conflict type is unknown.", +"Conflict is blocking, the upgrade would fail.", +"Conflict is non-blocking. The upgrade would succeed, but the environment configuration would be changed." +], +"type": "string" +} +}, +"type": "object" +}, "DagProcessorResource": { "description": "Configuration for resources used by Airflow DAG processors. This field is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer.", "id": "DagProcessorResource", @@ -1934,6 +1972,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/config.v1.json b/googleapiclient/discovery_cache/documents/config.v1.json index 20362ebde9..c4128c37ff 100644 --- a/googleapiclient/discovery_cache/documents/config.v1.json +++ b/googleapiclient/discovery_cache/documents/config.v1.json @@ -930,6 +930,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1345,7 +1350,7 @@ } } }, -"revision": "20250907", +"revision": "20250924", "rootUrl": "https://config.googleapis.com/", "schemas": { "ApplyResults": { @@ -1857,6 +1862,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json b/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json index 0fe6d2671f..55ea5623c9 100644 --- a/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json @@ -501,6 +501,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1alpha1/{+name}/operations", @@ -518,7 +523,7 @@ } } }, -"revision": "20250918", +"revision": "20250925", "rootUrl": "https://contactcenteraiplatform.googleapis.com/", "schemas": { "AdminUser": { @@ -907,6 +912,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index f742f487f4..feede55371 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -2660,7 +2660,7 @@ } } }, -"revision": "20250812", +"revision": "20250923", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2779,7 +2779,7 @@ }, "configConnectorConfig": { "$ref": "ConfigConnectorConfig", -"description": "Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API" +"description": "Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API." }, "dnsCacheConfig": { "$ref": "DnsCacheConfig", @@ -2791,7 +2791,7 @@ }, "gcpFilestoreCsiDriverConfig": { "$ref": "GcpFilestoreCsiDriverConfig", -"description": "Configuration for the GCP Filestore CSI driver." +"description": "Configuration for the Filestore CSI driver." }, "gcsFuseCsiDriverConfig": { "$ref": "GcsFuseCsiDriverConfig", @@ -3122,6 +3122,18 @@ }, "type": "object" }, +"AutoscaledRolloutPolicy": { +"description": "Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools.", +"id": "AutoscaledRolloutPolicy", +"properties": { +"waitForDrainDuration": { +"description": "Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, "BestEffortProvisioning": { "description": "Best effort provisioning.", "id": "BestEffortProvisioning", @@ -3232,6 +3244,10 @@ "description": "Settings for blue-green upgrade.", "id": "BlueGreenSettings", "properties": { +"autoscaledRolloutPolicy": { +"$ref": "AutoscaledRolloutPolicy", +"description": "Autoscaled policy for cluster autoscaler enabled blue-green upgrade." +}, "nodePoolSoakDuration": { "description": "Time needed after draining entire blue pool. After this period, blue pool will be cleaned up.", "format": "google-duration", @@ -3500,7 +3516,8 @@ }, "enterpriseConfig": { "$ref": "EnterpriseConfig", -"description": "GKE Enterprise Configuration." +"deprecated": true, +"description": "GKE Enterprise Configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier." }, "etag": { "description": "This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.", @@ -3762,7 +3779,7 @@ }, "workloadIdentityConfig": { "$ref": "WorkloadIdentityConfig", -"description": "Configuration for the use of Kubernetes Service Accounts in GCP IAM policies." +"description": "Configuration for the use of Kubernetes Service Accounts in IAM policies." }, "zone": { "deprecated": true, @@ -3948,7 +3965,8 @@ }, "desiredEnterpriseConfig": { "$ref": "DesiredEnterpriseConfig", -"description": "The desired enterprise configuration for the cluster." +"deprecated": true, +"description": "The desired enterprise configuration for the cluster. Deprecated: GKE Enterprise features are now available without an Enterprise tier." }, "desiredFleet": { "$ref": "Fleet", @@ -4523,7 +4541,15 @@ "id": "DNSEndpointConfig", "properties": { "allowExternalTraffic": { -"description": "Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false.", +"description": "Controls whether user traffic is allowed over this endpoint. Note that Google-managed services may still use the endpoint even if this is false.", +"type": "boolean" +}, +"enableK8sCertsViaDns": { +"description": "Controls whether the k8s certs auth is allowed via DNS.", +"type": "boolean" +}, +"enableK8sTokensViaDns": { +"description": "Controls whether the k8s token auth is allowed via DNS.", "type": "boolean" }, "endpoint": { @@ -4651,7 +4677,8 @@ "type": "object" }, "DesiredEnterpriseConfig": { -"description": "DesiredEnterpriseConfig is a wrapper used for updating enterprise_config.", +"deprecated": true, +"description": "DesiredEnterpriseConfig is a wrapper used for updating enterprise_config. Deprecated: GKE Enterprise features are now available without an Enterprise tier.", "id": "DesiredEnterpriseConfig", "properties": { "desiredTier": { @@ -4689,7 +4716,8 @@ "type": "object" }, "EnterpriseConfig": { -"description": "EnterpriseConfig is the cluster enterprise configuration.", +"deprecated": true, +"description": "EnterpriseConfig is the cluster enterprise configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier.", "id": "EnterpriseConfig", "properties": { "clusterTier": { @@ -5018,11 +5046,11 @@ false "type": "object" }, "GcpFilestoreCsiDriverConfig": { -"description": "Configuration for the GCP Filestore CSI driver.", +"description": "Configuration for the Filestore CSI driver.", "id": "GcpFilestoreCsiDriverConfig", "properties": { "enabled": { -"description": "Whether the GCP Filestore CSI driver is enabled for this cluster.", +"description": "Whether the Filestore CSI driver is enabled for this cluster.", "type": "boolean" } }, @@ -5534,7 +5562,7 @@ false "enumDescriptions": [ "Default value. GKE will not modify the kernel configuration.", "It means that an application requesting THP will stall on allocation failure and directly reclaim pages and compact memory in an effort to allocate a THP immediately.", -"It means that an application will wake kswapd in the background to reclaim pages and wake kcompactd to compact memory so that THP is available in the near future. It\u2019s the responsibility of khugepaged to then install the THP pages later.", +"It means that an application will wake kswapd in the background to reclaim pages and wake kcompactd to compact memory so that THP is available in the near future. It's the responsibility of khugepaged to then install the THP pages later.", "It means that an application will enter direct reclaim and compaction like always, but only for regions that have used madvise(MADV_HUGEPAGE); all other regions will wake kswapd in the background to reclaim pages and wake kcompactd to compact memory so that THP is available in the near future.", "It means that an application will enter direct reclaim like always but only for regions that are have used madvise(MADV_HUGEPAGE). This is the default kernel configuration.", "It means that an application will never enter direct reclaim or compaction." @@ -7652,7 +7680,7 @@ false "type": "object" }, "ResourceLabels": { -"description": "Collection of [GCP labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels).", +"description": "Collection of [Resource Manager labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels).", "id": "ResourceLabels", "properties": { "labels": { @@ -9288,7 +9316,7 @@ false "type": "object" }, "WorkloadIdentityConfig": { -"description": "Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.", +"description": "Configuration for the use of Kubernetes Service Accounts in IAM policies.", "id": "WorkloadIdentityConfig", "properties": { "workloadPool": { diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index 93d600c4b6..ca9f7614c6 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -2685,7 +2685,7 @@ } } }, -"revision": "20250916", +"revision": "20250923", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3191,7 +3191,13 @@ "AutoscaledRolloutPolicy": { "description": "Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools.", "id": "AutoscaledRolloutPolicy", -"properties": {}, +"properties": { +"waitForDrainDuration": { +"description": "Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive.", +"format": "google-duration", +"type": "string" +} +}, "type": "object" }, "AvailableVersion": { diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json index 86c6b639fe..7140f6615e 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json @@ -1452,7 +1452,7 @@ } } }, -"revision": "20250829", +"revision": "20250928", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AnalysisCompleted": { @@ -5150,6 +5150,10 @@ false }, "type": "array" }, +"chainId": { +"description": "The chain ID of the layer in the container image.", +"type": "string" +}, "command": { "description": "The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built.", "type": "string" @@ -6624,12 +6628,52 @@ false "enum": [ "SECRET_KIND_UNSPECIFIED", "SECRET_KIND_UNKNOWN", -"SECRET_KIND_GCP_SERVICE_ACCOUNT_KEY" +"SECRET_KIND_GCP_SERVICE_ACCOUNT_KEY", +"SECRET_KIND_GCP_API_KEY", +"SECRET_KIND_GCP_OAUTH2_CLIENT_CREDENTIALS", +"SECRET_KIND_GCP_OAUTH2_ACCESS_TOKEN", +"SECRET_KIND_ANTHROPIC_ADMIN_API_KEY", +"SECRET_KIND_ANTHROPIC_API_KEY", +"SECRET_KIND_AZURE_ACCESS_TOKEN", +"SECRET_KIND_AZURE_IDENTITY_TOKEN", +"SECRET_KIND_DOCKER_HUB_PERSONAL_ACCESS_TOKEN", +"SECRET_KIND_GITHUB_APP_REFRESH_TOKEN", +"SECRET_KIND_GITHUB_APP_SERVER_TO_SERVER_TOKEN", +"SECRET_KIND_GITHUB_APP_USER_TO_SERVER_TOKEN", +"SECRET_KIND_GITHUB_CLASSIC_PERSONAL_ACCESS_TOKEN", +"SECRET_KIND_GITHUB_FINE_GRAINED_PERSONAL_ACCESS_TOKEN", +"SECRET_KIND_GITHUB_OAUTH_TOKEN", +"SECRET_KIND_HUGGINGFACE_API_KEY", +"SECRET_KIND_OPENAI_API_KEY", +"SECRET_KIND_PERPLEXITY_API_KEY", +"SECRET_KIND_STRIPE_SECRET_KEY", +"SECRET_KIND_STRIPE_RESTRICTED_KEY", +"SECRET_KIND_STRIPE_WEBHOOK_SECRET" ], "enumDescriptions": [ "Unspecified", "The secret kind is unknown.", -"A GCP service account key per: https://cloud.google.com/iam/docs/creating-managing-service-account-keys" +"A Google Cloud service account key per: https://cloud.google.com/iam/docs/creating-managing-service-account-keys", +"A Google Cloud API key per: https://cloud.google.com/docs/authentication/api-keys", +"A Google Cloud OAuth2 client credentials per: https://developers.google.com/identity/protocols/oauth2", +"A Google Cloud OAuth2 access token per: https://cloud.google.com/docs/authentication/token-types#access", +"An Anthropic Admin API key. This is called Workspace API key in Scalibr.", +"An Anthropic API key. This is called Model key in Scalibr.", +"An Azure access token.", +"An Azure Identity Platform ID token.", +"A Docker Hub personal access token.", +"A GitHub App refresh token.", +"A GitHub App server-to-server token.", +"A GitHub App user-to-server token.", +"A GitHub personal access token (classic).", +"A GitHub fine-grained personal access token.", +"A GitHub OAuth token.", +"A Hugging Face API key.", +"An OpenAI API key.", +"A Perplexity API key.", +"A Stripe secret key.", +"A Stripe restricted key.", +"A Stripe webhook secret." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json index 8ae6671e8f..4f1f5bd99d 100644 --- a/googleapiclient/discovery_cache/documents/dataplex.v1.json +++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json @@ -716,6 +716,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1196,6 +1201,97 @@ } } }, +"changeRequests": { +"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}/changeRequests/{changeRequestsId}:getIamPolicy", +"httpMethod": "GET", +"id": "dataplex.projects.locations.changeRequests.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/[^/]+/changeRequests/[^/]+$", +"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}/changeRequests/{changeRequestsId}:setIamPolicy", +"httpMethod": "POST", +"id": "dataplex.projects.locations.changeRequests.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/[^/]+/changeRequests/[^/]+$", +"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}/changeRequests/{changeRequestsId}:testIamPermissions", +"httpMethod": "POST", +"id": "dataplex.projects.locations.changeRequests.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/[^/]+/changeRequests/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "GoogleIamV1TestIamPermissionsRequest" +}, +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "dataAttributeBindings": { "methods": { "create": { @@ -7132,6 +7228,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -7149,7 +7250,7 @@ } } }, -"revision": "20250919", +"revision": "20250924", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -8595,7 +8696,7 @@ "id": "GoogleCloudDataplexV1DataDocumentationResultTableResult", "properties": { "name": { -"description": "Output only. The service-qualified full resource name of the cloud resource. Ex: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID", +"description": "Output only. The service-qualified full resource name of the cloud resource. Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID", "readOnly": true, "type": "string" }, @@ -10477,6 +10578,10 @@ "readOnly": true, "type": "string" }, +"enableMetastoreEncryption": { +"description": "Optional. Represent the state of CMEK opt-in for metastore.", +"type": "boolean" +}, "encryptionState": { "description": "Output only. The state of encryption of the databases.", "enum": [ @@ -14247,6 +14352,13 @@ "$ref": "GoogleLongrunningOperation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/dataproc.v1.json b/googleapiclient/discovery_cache/documents/dataproc.v1.json index 61a7d956f1..dc58f51c40 100644 --- a/googleapiclient/discovery_cache/documents/dataproc.v1.json +++ b/googleapiclient/discovery_cache/documents/dataproc.v1.json @@ -5012,7 +5012,7 @@ } } }, -"revision": "20250813", +"revision": "20251001", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -9619,6 +9619,10 @@ "description": "Optional. Specifying the cluster_uuid means the RPC will fail (with error NOT_FOUND) if a cluster with the specified UUID does not exist.", "type": "string" }, +"dataprocSuperUser": { +"description": "Optional. Whether the request is submitted by Dataproc super user. If true, IAM will check 'dataproc.clusters.repair' permission instead of 'dataproc.clusters.update' permission. This is to give Dataproc superuser the ability to repair clusters without granting the overly broad update permission.", +"type": "boolean" +}, "gracefulDecommissionTimeout": { "description": "Optional. Timeout for graceful YARN decommissioning. Graceful decommissioning facilitates the removal of cluster nodes without interrupting jobs in progress. The timeout specifies the amount of time to wait for jobs finish before forcefully removing nodes. The default timeout is 0 for forceful decommissioning, and the maximum timeout period is 1 day. (see JSON Mapping\u2014Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).graceful_decommission_timeout is supported in Dataproc image versions 1.2+.", "format": "google-duration", @@ -12600,11 +12604,6 @@ "format": "int64", "type": "string" }, -"milliSlotSeconds": { -"description": "Optional. Slot usage in (milliSlot x seconds).", -"format": "int64", -"type": "string" -}, "shuffleStorageGbSeconds": { "description": "Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).", "format": "int64", @@ -12641,11 +12640,6 @@ "format": "int64", "type": "string" }, -"milliSlot": { -"description": "Optional. Milli (one-thousandth) Slot usage of the workload.", -"format": "int64", -"type": "string" -}, "shuffleStorageGb": { "description": "Optional. Shuffle Storage in gigabytes (GB). (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))", "format": "int64", diff --git a/googleapiclient/discovery_cache/documents/developerconnect.v1.json b/googleapiclient/discovery_cache/documents/developerconnect.v1.json index 717afe1fc2..5eb0a40344 100644 --- a/googleapiclient/discovery_cache/documents/developerconnect.v1.json +++ b/googleapiclient/discovery_cache/documents/developerconnect.v1.json @@ -1584,6 +1584,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1601,7 +1606,7 @@ } } }, -"revision": "20250904", +"revision": "20250929", "rootUrl": "https://developerconnect.googleapis.com/", "schemas": { "AccountConnector": { @@ -2602,6 +2607,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2.json b/googleapiclient/discovery_cache/documents/dialogflow.v2.json index 958b519d1b..70a7f17b6f 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2.json @@ -8656,6 +8656,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2/{+name}/operations", @@ -9008,6 +9013,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2/{+name}/operations", @@ -9086,7 +9096,7 @@ } } }, -"revision": "20250919", +"revision": "20250930", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -14217,6 +14227,233 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2AgentCoachingContext": { +"description": "Agent Coaching context that customer can configure.", +"id": "GoogleCloudDialogflowV2AgentCoachingContext", +"properties": { +"instructions": { +"description": "Optional. Customized instructions for agent coaching.", +"items": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingInstruction" +}, +"type": "array" +}, +"outputLanguageCode": { +"description": "Optional. Output language code.", +"type": "string" +}, +"overarchingGuidance": { +"description": "Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions.", +"type": "string" +}, +"version": { +"description": "Optional. Version of the feature. If not set, default to latest version. Current candidates are [\"1.2\"].", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingInstruction": { +"description": "Agent Coaching instructions that customer can configure.", +"id": "GoogleCloudDialogflowV2AgentCoachingInstruction", +"properties": { +"agentAction": { +"description": "Optional. The action that human agent should take. For example, \"apologize for the slow shipping\". If the users only want to use agent coaching for intent detection, agent_action can be empty", +"type": "string" +}, +"condition": { +"description": "Optional. The condition of the instruction. For example, \"the customer wants to cancel an order\". If the users want the instruction to be triggered unconditionally, the condition can be empty.", +"type": "string" +}, +"displayDetails": { +"description": "Optional. The detailed description of this instruction.", +"type": "string" +}, +"displayName": { +"description": "Optional. Display name for the instruction.", +"type": "string" +}, +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult", +"description": "Output only. Duplication check for the AgentCoachingInstruction.", +"readOnly": true +}, +"systemAction": { +"description": "Optional. The action that system should take. For example, \"call GetOrderTime with order_number={order number provided by the customer}\". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult": { +"description": "Duplication check for the suggestion.", +"id": "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult", +"properties": { +"duplicateSuggestions": { +"description": "Output only. The duplicate suggestions.", +"items": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion": { +"description": "The duplicate suggestion details.", +"id": "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion", +"properties": { +"answerRecord": { +"description": "Output only. The answer record id of the past duplicate suggestion.", +"readOnly": true, +"type": "string" +}, +"similarityScore": { +"description": "Output only. The similarity score of between the past and current suggestion.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"suggestionIndex": { +"description": "Output only. The index of the duplicate suggestion in the past suggestion list.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestion": { +"description": "Suggestion for coaching agents.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestion", +"properties": { +"agentActionSuggestions": { +"description": "Optional. Suggested actions for the agent to take.", +"items": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion" +}, +"type": "array" +}, +"applicableInstructions": { +"description": "Optional. Instructions applicable based on the current context.", +"items": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingInstruction" +}, +"type": "array" +}, +"sampleResponses": { +"description": "Optional. Sample response for the Agent.", +"items": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion": { +"description": "Actions suggested for the agent. This is based on applicable instructions.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion", +"properties": { +"agentAction": { +"description": "Optional. The suggested action for the agent.", +"type": "string" +}, +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult", +"description": "Output only. Duplicate check result for the agent action suggestion.", +"readOnly": true +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionSources", +"description": "Output only. Sources for the agent action suggestion.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult": { +"description": "Duplication check for the suggestion.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult", +"properties": { +"duplicateSuggestions": { +"description": "Output only. The duplicate suggestions.", +"items": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion": { +"description": "The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion", +"properties": { +"answerRecord": { +"description": "Output only. The answer record id of the past duplicate suggestion.", +"readOnly": true, +"type": "string" +}, +"similarityScore": { +"description": "Output only. The similarity score of between the past and current suggestion.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionSources", +"description": "Output only. Sources for the suggestion.", +"readOnly": true +}, +"suggestionIndex": { +"description": "Output only. The index of the duplicate suggestion in the past suggestion list.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse": { +"description": "Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse", +"properties": { +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult", +"description": "Output only. Duplicate check result for the sample response.", +"readOnly": true +}, +"responseText": { +"description": "Optional. Sample response for Agent in text.", +"type": "string" +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionSources", +"description": "Output only. Sources for the Sample Response.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestionSources": { +"description": "Sources for the suggestion.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestionSources", +"properties": { +"instructionIndexes": { +"description": "Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field.", +"items": { +"format": "int32", +"type": "integer" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2AnalyzeContentRequest": { "description": "The request message for Participants.AnalyzeContent.", "id": "GoogleCloudDialogflowV2AnalyzeContentRequest", @@ -15041,6 +15278,10 @@ true "description": "Contents ingested.", "id": "GoogleCloudDialogflowV2ConversationContextReferenceContextContent", "properties": { +"answerRecord": { +"description": "If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`.", +"type": "string" +}, "content": { "description": "Required. The information ingested in a single request.", "type": "string" @@ -16572,6 +16813,10 @@ true "description": "LLM generator.", "id": "GoogleCloudDialogflowV2Generator", "properties": { +"agentCoachingContext": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingContext", +"description": "Input of prebuilt Agent Coaching feature." +}, "createTime": { "description": "Output only. Creation time of this generator.", "format": "google-datetime", @@ -16599,6 +16844,10 @@ true "description": "Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`.", "type": "string" }, +"suggestionDedupingConfig": { +"$ref": "GoogleCloudDialogflowV2SuggestionDedupingConfig", +"description": "Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature." +}, "summarizationContext": { "$ref": "GoogleCloudDialogflowV2SummarizationContext", "description": "Input of prebuilt Summarization feature." @@ -16675,6 +16924,16 @@ true "readOnly": true, "type": "string" }, +"satisfiesPzi": { +"description": "Output only. A read only boolean field reflecting Zone Isolation status of the model. The field is an aggregated value of ZI status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. A read only boolean field reflecting Zone Separation status of the model. The field is an aggregated value of ZS status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status", +"readOnly": true, +"type": "boolean" +}, "summarizationMetrics": { "$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetrics", "description": "Output only. Only available when the summarization generator is provided.", @@ -16834,6 +17093,10 @@ true "description": "Suggestion generated using a Generator.", "id": "GoogleCloudDialogflowV2GeneratorSuggestion", "properties": { +"agentCoachingSuggestion": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestion", +"description": "Optional. Suggestion to coach the agent." +}, "freeFormSuggestion": { "$ref": "GoogleCloudDialogflowV2FreeFormSuggestion", "description": "Optional. Free form suggestion." @@ -16940,6 +17203,10 @@ true "description": "Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST", "type": "boolean" }, +"enableAsyncToolCall": { +"description": "Optional. If true, enable asynchronous execution of tools.", +"type": "boolean" +}, "featureConfigs": { "description": "Configuration of different suggestion features. One feature can have only one config.", "items": { @@ -16957,6 +17224,14 @@ true "groupSuggestionResponses": { "description": "If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse.", "type": "boolean" +}, +"skipEmptyEventBasedSuggestion": { +"description": "Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation.", +"type": "boolean" +}, +"useUnredactedConversationData": { +"description": "Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features)", +"type": "boolean" } }, "type": "object" @@ -16993,10 +17268,18 @@ true "description": "Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST", "type": "boolean" }, +"enableResponseDebugInfo": { +"description": "Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST", +"type": "boolean" +}, "queryConfig": { "$ref": "GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfig", "description": "Configs of query." }, +"raiSettings": { +"$ref": "GoogleCloudDialogflowV2RaiSettings", +"description": "Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST" +}, "suggestionFeature": { "$ref": "GoogleCloudDialogflowV2SuggestionFeature", "description": "The suggestion feature." @@ -19468,6 +19751,63 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2RaiSettings": { +"description": "Settings for Responsible AI checks.", +"id": "GoogleCloudDialogflowV2RaiSettings", +"properties": { +"raiCategoryConfigs": { +"description": "Configuration for a set of RAI categories.", +"items": { +"$ref": "GoogleCloudDialogflowV2RaiSettingsRaiCategoryConfig" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2RaiSettingsRaiCategoryConfig": { +"description": "Configuration for a specific RAI category.", +"id": "GoogleCloudDialogflowV2RaiSettingsRaiCategoryConfig", +"properties": { +"category": { +"description": "Optional. The RAI category.", +"enum": [ +"RAI_CATEGORY_UNSPECIFIED", +"DANGEROUS_CONTENT", +"SEXUALLY_EXPLICIT", +"HARASSMENT", +"HATE_SPEECH" +], +"enumDescriptions": [ +"Default value.", +"Dangerous content.", +"Sexually explicit content.", +"Harassment content.", +"Hate speech content." +], +"type": "string" +}, +"sensitivityLevel": { +"description": "Optional. The sensitivity level for this category.", +"enum": [ +"SENSITIVITY_LEVEL_UNSPECIFIED", +"BLOCK_MOST", +"BLOCK_SOME", +"BLOCK_FEW", +"BLOCK_NONE" +], +"enumDescriptions": [ +"Default value. If unspecified, the default behavior is: - DANGEROUS_CONTENT: BLOCK_FEW - SEXUALLY_EXPLICIT: BLOCK_SOME - HARASSMENT: BLOCK_SOME - HATE_SPEECH: BLOCK_SOME", +"Block most potentially sensitive responses.", +"Block some potentially sensitive responses.", +"Block a few potentially sensitive responses.", +"No filtering for this category." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2ReloadDocumentRequest": { "description": "Request message for Documents.ReloadDocument.", "id": "GoogleCloudDialogflowV2ReloadDocumentRequest", @@ -20492,6 +20832,22 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2SuggestionDedupingConfig": { +"description": "Config for suggestion deduping. NEXT_ID: 3", +"id": "GoogleCloudDialogflowV2SuggestionDedupingConfig", +"properties": { +"enableDeduping": { +"description": "Optional. Whether to enable suggestion deduping.", +"type": "boolean" +}, +"similarityThreshold": { +"description": "Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2SuggestionFeature": { "description": "The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list.", "id": "GoogleCloudDialogflowV2SuggestionFeature", @@ -20522,11 +20878,40 @@ true "type": "object" }, "GoogleCloudDialogflowV2SuggestionInput": { -"description": "Represents the selection of a suggestion.", +"description": "Represents the action to take for a tool call that requires confirmation.", "id": "GoogleCloudDialogflowV2SuggestionInput", "properties": { +"action": { +"description": "Optional. The type of action to take with the tool.", +"enum": [ +"ACTION_UNSPECIFIED", +"CANCEL", +"REVISE", +"CONFIRM" +], +"enumDescriptions": [ +"Action not specified.", +"Indicates the user chooses to not make the tool call. It is only applicable to tool calls that are waiting for user confirmation.", +"Makes the tool call with provided parameters. This action is intended for tool calls that only read but not write data.", +"Makes the tool call with provided parameters. This action is intended for tool calls that may write data." +], +"type": "string" +}, "answerRecord": { -"description": "Required. The ID of a suggestion selected by the human agent. The suggestion(s) were generated in a previous call to request Dialogflow assist. The format is: `projects//locations//answerRecords/` where is an alphanumeric string.", +"description": "Required. Format: `projects//locations//answerRecords/` The answer record associated with the tool call.", +"type": "string" +}, +"parameters": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Parameters to be used for the tool call. If not provided, the tool will be called without any parameters.", +"type": "object" +}, +"sendTime": { +"description": "Optional. Time when the current suggest input is sent. For tool calls, this timestamp (along with the answer record) will be included in the corresponding tool call result so that it can be identified.", +"format": "google-datetime", "type": "string" } }, @@ -21126,6 +21511,10 @@ true "description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, +"answerRecord": { +"description": "Optional. The answer record associated with this tool call.", +"type": "string" +}, "createTime": { "description": "Output only. Create time of the tool call.", "format": "google-datetime", @@ -21140,9 +21529,32 @@ true "description": "Optional. The action's input parameters.", "type": "object" }, +"state": { +"description": "Output only. State of the tool call.", +"enum": [ +"STATE_UNSPECIFIED", +"TRIGGERED", +"NEEDS_CONFIRMATION" +], +"enumDescriptions": [ +"Default value.", +"The tool call has been triggered.", +"The tool call requires confirmation from a human." +], +"readOnly": true, +"type": "string" +}, "tool": { "description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" +}, +"toolDisplayDetails": { +"description": "Optional. A human readable description of the tool.", +"type": "string" +}, +"toolDisplayName": { +"description": "Optional. A human readable short name of the tool, to be shown on the UI.", +"type": "string" } }, "type": "object" @@ -21155,6 +21567,10 @@ true "description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, +"answerRecord": { +"description": "Optional. The answer record associated with this tool call result.", +"type": "string" +}, "content": { "description": "Only populated if the response content is utf-8 encoded.", "type": "string" @@ -21418,6 +21834,207 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1AgentCoachingInstruction": { +"description": "Agent Coaching instructions that customer can configure.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingInstruction", +"properties": { +"agentAction": { +"description": "Optional. The action that human agent should take. For example, \"apologize for the slow shipping\". If the users only want to use agent coaching for intent detection, agent_action can be empty", +"type": "string" +}, +"condition": { +"description": "Optional. The condition of the instruction. For example, \"the customer wants to cancel an order\". If the users want the instruction to be triggered unconditionally, the condition can be empty.", +"type": "string" +}, +"displayDetails": { +"description": "Optional. The detailed description of this instruction.", +"type": "string" +}, +"displayName": { +"description": "Optional. Display name for the instruction.", +"type": "string" +}, +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult", +"description": "Output only. Duplication check for the AgentCoachingInstruction.", +"readOnly": true +}, +"systemAction": { +"description": "Optional. The action that system should take. For example, \"call GetOrderTime with order_number={order number provided by the customer}\". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult": { +"description": "Duplication check for the suggestion.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult", +"properties": { +"duplicateSuggestions": { +"description": "Output only. The duplicate suggestions.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion": { +"description": "The duplicate suggestion details.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion", +"properties": { +"answerRecord": { +"description": "Output only. The answer record id of the past duplicate suggestion.", +"readOnly": true, +"type": "string" +}, +"similarityScore": { +"description": "Output only. The similarity score of between the past and current suggestion.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"suggestionIndex": { +"description": "Output only. The index of the duplicate suggestion in the past suggestion list.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestion": { +"description": "Suggestion for coaching agents.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestion", +"properties": { +"agentActionSuggestions": { +"description": "Optional. Suggested actions for the agent to take.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion" +}, +"type": "array" +}, +"applicableInstructions": { +"description": "Optional. Instructions applicable based on the current context.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingInstruction" +}, +"type": "array" +}, +"sampleResponses": { +"description": "Optional. Sample response for the Agent.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion": { +"description": "Actions suggested for the agent. This is based on applicable instructions.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion", +"properties": { +"agentAction": { +"description": "Optional. The suggested action for the agent.", +"type": "string" +}, +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult", +"description": "Output only. Duplicate check result for the agent action suggestion.", +"readOnly": true +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources", +"description": "Output only. Sources for the agent action suggestion.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult": { +"description": "Duplication check for the suggestion.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult", +"properties": { +"duplicateSuggestions": { +"description": "Output only. The duplicate suggestions.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion": { +"description": "The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion", +"properties": { +"answerRecord": { +"description": "Output only. The answer record id of the past duplicate suggestion.", +"readOnly": true, +"type": "string" +}, +"similarityScore": { +"description": "Output only. The similarity score of between the past and current suggestion.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources", +"description": "Output only. Sources for the suggestion.", +"readOnly": true +}, +"suggestionIndex": { +"description": "Output only. The index of the duplicate suggestion in the past suggestion list.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse": { +"description": "Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse", +"properties": { +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult", +"description": "Output only. Duplicate check result for the sample response.", +"readOnly": true +}, +"responseText": { +"description": "Optional. Sample response for Agent in text.", +"type": "string" +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources", +"description": "Output only. Sources for the Sample Response.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources": { +"description": "Sources for the suggestion.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources", +"properties": { +"instructionIndexes": { +"description": "Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field.", +"items": { +"format": "int32", +"type": "integer" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1AnnotatedMessagePart": { "description": "Represents a part of a message possibly annotated with an entity. The part can be an entity or purely a part of the message between two entities or message start/end.", "id": "GoogleCloudDialogflowV2beta1AnnotatedMessagePart", @@ -21877,6 +22494,10 @@ true "description": "Suggestion generated using a Generator.", "id": "GoogleCloudDialogflowV2beta1GeneratorSuggestion", "properties": { +"agentCoachingSuggestion": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestion", +"description": "Optional. Suggestion to coach the agent." +}, "freeFormSuggestion": { "$ref": "GoogleCloudDialogflowV2beta1FreeFormSuggestion", "description": "Optional. Free form suggestion." @@ -24183,6 +24804,10 @@ true "description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, +"answerRecord": { +"description": "Optional. The answer record associated with this tool call.", +"type": "string" +}, "createTime": { "description": "Output only. Create time of the tool call.", "format": "google-datetime", @@ -24197,9 +24822,32 @@ true "description": "Optional. The action's input parameters.", "type": "object" }, +"state": { +"description": "Output only. State of the tool call", +"enum": [ +"STATE_UNSPECIFIED", +"TRIGGERED", +"NEEDS_CONFIRMATION" +], +"enumDescriptions": [ +"Default value.", +"The tool call has been triggered.", +"The tool call requires confirmation from a human." +], +"readOnly": true, +"type": "string" +}, "tool": { "description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" +}, +"toolDisplayDetails": { +"description": "Optional. A human readable description of the tool.", +"type": "string" +}, +"toolDisplayName": { +"description": "Optional. A human readable short name of the tool, to be shown on the UI.", +"type": "string" } }, "type": "object" @@ -24212,6 +24860,10 @@ true "description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, +"answerRecord": { +"description": "Optional. The answer record associated with this tool call result.", +"type": "string" +}, "content": { "description": "Only populated if the response content is utf-8 encoded.", "type": "string" @@ -24481,6 +25133,13 @@ true "$ref": "GoogleLongrunningOperation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json index ee4ceed08d..ec5c17786b 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json @@ -8024,6 +8024,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2beta1/{+name}/operations", @@ -8512,6 +8517,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2beta1/{+name}/operations", @@ -8726,7 +8736,7 @@ } } }, -"revision": "20250919", +"revision": "20250930", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -13605,6 +13615,207 @@ }, "type": "object" }, +"GoogleCloudDialogflowV2AgentCoachingInstruction": { +"description": "Agent Coaching instructions that customer can configure.", +"id": "GoogleCloudDialogflowV2AgentCoachingInstruction", +"properties": { +"agentAction": { +"description": "Optional. The action that human agent should take. For example, \"apologize for the slow shipping\". If the users only want to use agent coaching for intent detection, agent_action can be empty", +"type": "string" +}, +"condition": { +"description": "Optional. The condition of the instruction. For example, \"the customer wants to cancel an order\". If the users want the instruction to be triggered unconditionally, the condition can be empty.", +"type": "string" +}, +"displayDetails": { +"description": "Optional. The detailed description of this instruction.", +"type": "string" +}, +"displayName": { +"description": "Optional. Display name for the instruction.", +"type": "string" +}, +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult", +"description": "Output only. Duplication check for the AgentCoachingInstruction.", +"readOnly": true +}, +"systemAction": { +"description": "Optional. The action that system should take. For example, \"call GetOrderTime with order_number={order number provided by the customer}\". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult": { +"description": "Duplication check for the suggestion.", +"id": "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult", +"properties": { +"duplicateSuggestions": { +"description": "Output only. The duplicate suggestions.", +"items": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion": { +"description": "The duplicate suggestion details.", +"id": "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion", +"properties": { +"answerRecord": { +"description": "Output only. The answer record id of the past duplicate suggestion.", +"readOnly": true, +"type": "string" +}, +"similarityScore": { +"description": "Output only. The similarity score of between the past and current suggestion.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"suggestionIndex": { +"description": "Output only. The index of the duplicate suggestion in the past suggestion list.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestion": { +"description": "Suggestion for coaching agents.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestion", +"properties": { +"agentActionSuggestions": { +"description": "Optional. Suggested actions for the agent to take.", +"items": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion" +}, +"type": "array" +}, +"applicableInstructions": { +"description": "Optional. Instructions applicable based on the current context.", +"items": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingInstruction" +}, +"type": "array" +}, +"sampleResponses": { +"description": "Optional. Sample response for the Agent.", +"items": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion": { +"description": "Actions suggested for the agent. This is based on applicable instructions.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion", +"properties": { +"agentAction": { +"description": "Optional. The suggested action for the agent.", +"type": "string" +}, +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult", +"description": "Output only. Duplicate check result for the agent action suggestion.", +"readOnly": true +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionSources", +"description": "Output only. Sources for the agent action suggestion.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult": { +"description": "Duplication check for the suggestion.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult", +"properties": { +"duplicateSuggestions": { +"description": "Output only. The duplicate suggestions.", +"items": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion": { +"description": "The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion", +"properties": { +"answerRecord": { +"description": "Output only. The answer record id of the past duplicate suggestion.", +"readOnly": true, +"type": "string" +}, +"similarityScore": { +"description": "Output only. The similarity score of between the past and current suggestion.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionSources", +"description": "Output only. Sources for the suggestion.", +"readOnly": true +}, +"suggestionIndex": { +"description": "Output only. The index of the duplicate suggestion in the past suggestion list.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse": { +"description": "Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse", +"properties": { +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult", +"description": "Output only. Duplicate check result for the sample response.", +"readOnly": true +}, +"responseText": { +"description": "Optional. Sample response for Agent in text.", +"type": "string" +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionSources", +"description": "Output only. Sources for the Sample Response.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestionSources": { +"description": "Sources for the suggestion.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestionSources", +"properties": { +"instructionIndexes": { +"description": "Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field.", +"items": { +"format": "int32", +"type": "integer" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2AnnotatedMessagePart": { "description": "Represents a part of a message possibly annotated with an entity. The part can be an entity or purely a part of the message between two entities or message start/end.", "id": "GoogleCloudDialogflowV2AnnotatedMessagePart", @@ -14288,6 +14499,10 @@ "description": "Suggestion generated using a Generator.", "id": "GoogleCloudDialogflowV2GeneratorSuggestion", "properties": { +"agentCoachingSuggestion": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestion", +"description": "Optional. Suggestion to coach the agent." +}, "freeFormSuggestion": { "$ref": "GoogleCloudDialogflowV2FreeFormSuggestion", "description": "Optional. Free form suggestion." @@ -16068,6 +16283,10 @@ true "description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, +"answerRecord": { +"description": "Optional. The answer record associated with this tool call.", +"type": "string" +}, "createTime": { "description": "Output only. Create time of the tool call.", "format": "google-datetime", @@ -16082,9 +16301,32 @@ true "description": "Optional. The action's input parameters.", "type": "object" }, +"state": { +"description": "Output only. State of the tool call.", +"enum": [ +"STATE_UNSPECIFIED", +"TRIGGERED", +"NEEDS_CONFIRMATION" +], +"enumDescriptions": [ +"Default value.", +"The tool call has been triggered.", +"The tool call requires confirmation from a human." +], +"readOnly": true, +"type": "string" +}, "tool": { "description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" +}, +"toolDisplayDetails": { +"description": "Optional. A human readable description of the tool.", +"type": "string" +}, +"toolDisplayName": { +"description": "Optional. A human readable short name of the tool, to be shown on the UI.", +"type": "string" } }, "type": "object" @@ -16097,6 +16339,10 @@ true "description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, +"answerRecord": { +"description": "Optional. The answer record associated with this tool call result.", +"type": "string" +}, "content": { "description": "Only populated if the response content is utf-8 encoded.", "type": "string" @@ -16478,6 +16724,233 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1AgentCoachingContext": { +"description": "Agent Coaching context that customer can configure.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingContext", +"properties": { +"instructions": { +"description": "Optional. Customized instructions for agent coaching.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingInstruction" +}, +"type": "array" +}, +"outputLanguageCode": { +"description": "Optional. Output language code.", +"type": "string" +}, +"overarchingGuidance": { +"description": "Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions.", +"type": "string" +}, +"version": { +"description": "Optional. Version of the feature. If not set, default to latest version. Current candidates are [\"2.5\"].", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingInstruction": { +"description": "Agent Coaching instructions that customer can configure.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingInstruction", +"properties": { +"agentAction": { +"description": "Optional. The action that human agent should take. For example, \"apologize for the slow shipping\". If the users only want to use agent coaching for intent detection, agent_action can be empty", +"type": "string" +}, +"condition": { +"description": "Optional. The condition of the instruction. For example, \"the customer wants to cancel an order\". If the users want the instruction to be triggered unconditionally, the condition can be empty.", +"type": "string" +}, +"displayDetails": { +"description": "Optional. The detailed description of this instruction.", +"type": "string" +}, +"displayName": { +"description": "Optional. Display name for the instruction.", +"type": "string" +}, +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult", +"description": "Output only. Duplication check for the AgentCoachingInstruction.", +"readOnly": true +}, +"systemAction": { +"description": "Optional. The action that system should take. For example, \"call GetOrderTime with order_number={order number provided by the customer}\". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult": { +"description": "Duplication check for the suggestion.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult", +"properties": { +"duplicateSuggestions": { +"description": "Output only. The duplicate suggestions.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion": { +"description": "The duplicate suggestion details.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion", +"properties": { +"answerRecord": { +"description": "Output only. The answer record id of the past duplicate suggestion.", +"readOnly": true, +"type": "string" +}, +"similarityScore": { +"description": "Output only. The similarity score of between the past and current suggestion.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"suggestionIndex": { +"description": "Output only. The index of the duplicate suggestion in the past suggestion list.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestion": { +"description": "Suggestion for coaching agents.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestion", +"properties": { +"agentActionSuggestions": { +"description": "Optional. Suggested actions for the agent to take.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion" +}, +"type": "array" +}, +"applicableInstructions": { +"description": "Optional. Instructions applicable based on the current context.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingInstruction" +}, +"type": "array" +}, +"sampleResponses": { +"description": "Optional. Sample response for the Agent.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion": { +"description": "Actions suggested for the agent. This is based on applicable instructions.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion", +"properties": { +"agentAction": { +"description": "Optional. The suggested action for the agent.", +"type": "string" +}, +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult", +"description": "Output only. Duplicate check result for the agent action suggestion.", +"readOnly": true +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources", +"description": "Output only. Sources for the agent action suggestion.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult": { +"description": "Duplication check for the suggestion.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult", +"properties": { +"duplicateSuggestions": { +"description": "Output only. The duplicate suggestions.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion": { +"description": "The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion", +"properties": { +"answerRecord": { +"description": "Output only. The answer record id of the past duplicate suggestion.", +"readOnly": true, +"type": "string" +}, +"similarityScore": { +"description": "Output only. The similarity score of between the past and current suggestion.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources", +"description": "Output only. Sources for the suggestion.", +"readOnly": true +}, +"suggestionIndex": { +"description": "Output only. The index of the duplicate suggestion in the past suggestion list.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse": { +"description": "Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse", +"properties": { +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult", +"description": "Output only. Duplicate check result for the sample response.", +"readOnly": true +}, +"responseText": { +"description": "Optional. Sample response for Agent in text.", +"type": "string" +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources", +"description": "Output only. Sources for the Sample Response.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources": { +"description": "Sources for the suggestion.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources", +"properties": { +"instructionIndexes": { +"description": "Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field.", +"items": { +"format": "int32", +"type": "integer" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1AnalyzeContentRequest": { "description": "The request message for Participants.AnalyzeContent.", "id": "GoogleCloudDialogflowV2beta1AnalyzeContentRequest", @@ -17418,6 +17891,10 @@ true "description": "Contents ingested.", "id": "GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent", "properties": { +"answerRecord": { +"description": "If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`.", +"type": "string" +}, "content": { "description": "Required. The information ingested in a single request.", "type": "string" @@ -18582,6 +19059,10 @@ true "description": "LLM generator.", "id": "GoogleCloudDialogflowV2beta1Generator", "properties": { +"agentCoachingContext": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingContext", +"description": "Input of Agent Coaching feature." +}, "createTime": { "description": "Output only. Creation time of this generator.", "format": "google-datetime", @@ -18609,6 +19090,10 @@ true "description": "Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`.", "type": "string" }, +"suggestionDedupingConfig": { +"$ref": "GoogleCloudDialogflowV2beta1SuggestionDedupingConfig", +"description": "Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature." +}, "summarizationContext": { "$ref": "GoogleCloudDialogflowV2beta1SummarizationContext", "description": "Input of Summarization feature." @@ -18685,6 +19170,16 @@ true "readOnly": true, "type": "string" }, +"satisfiesPzi": { +"description": "Output only. A read only boolean field reflecting Zone Isolation status of the model. The field is an aggregated value of ZI status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. A read only boolean field reflecting Zone Separation status of the model. The field is an aggregated value of ZS status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status", +"readOnly": true, +"type": "boolean" +}, "summarizationMetrics": { "$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetrics", "description": "Output only. Only available when the summarization generator is provided.", @@ -18844,6 +19339,10 @@ true "description": "Suggestion generated using a Generator.", "id": "GoogleCloudDialogflowV2beta1GeneratorSuggestion", "properties": { +"agentCoachingSuggestion": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestion", +"description": "Optional. Suggestion to coach the agent." +}, "freeFormSuggestion": { "$ref": "GoogleCloudDialogflowV2beta1FreeFormSuggestion", "description": "Optional. Free form suggestion." @@ -18950,6 +19449,10 @@ true "description": "Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST", "type": "boolean" }, +"enableAsyncToolCall": { +"description": "Optional. If true, enable asynchronous execution of tools.", +"type": "boolean" +}, "featureConfigs": { "description": "Configuration of different suggestion features. One feature can have only one config.", "items": { @@ -18967,6 +19470,14 @@ true "groupSuggestionResponses": { "description": "If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse.", "type": "boolean" +}, +"skipEmptyEventBasedSuggestion": { +"description": "Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation.", +"type": "boolean" +}, +"useUnredactedConversationData": { +"description": "Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features)", +"type": "boolean" } }, "type": "object" @@ -19003,10 +19514,18 @@ true "description": "Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST", "type": "boolean" }, +"enableResponseDebugInfo": { +"description": "Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST", +"type": "boolean" +}, "queryConfig": { "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfig", "description": "Configs of query." }, +"raiSettings": { +"$ref": "GoogleCloudDialogflowV2beta1RaiSettings", +"description": "Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST" +}, "suggestionFeature": { "$ref": "GoogleCloudDialogflowV2beta1SuggestionFeature", "description": "The suggestion feature." @@ -21826,6 +22345,63 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1RaiSettings": { +"description": "Settings for Responsible AI checks.", +"id": "GoogleCloudDialogflowV2beta1RaiSettings", +"properties": { +"raiCategoryConfigs": { +"description": "Configuration for a set of RAI categories.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1RaiSettingsRaiCategoryConfig" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1RaiSettingsRaiCategoryConfig": { +"description": "Configuration for a specific RAI category.", +"id": "GoogleCloudDialogflowV2beta1RaiSettingsRaiCategoryConfig", +"properties": { +"category": { +"description": "Optional. The RAI category.", +"enum": [ +"RAI_CATEGORY_UNSPECIFIED", +"DANGEROUS_CONTENT", +"SEXUALLY_EXPLICIT", +"HARASSMENT", +"HATE_SPEECH" +], +"enumDescriptions": [ +"Default value.", +"Dangerous content.", +"Sexually explicit content.", +"Harassment content.", +"Hate speech content." +], +"type": "string" +}, +"sensitivityLevel": { +"description": "Optional. The sensitivity level for this category.", +"enum": [ +"SENSITIVITY_LEVEL_UNSPECIFIED", +"BLOCK_MOST", +"BLOCK_SOME", +"BLOCK_FEW", +"BLOCK_NONE" +], +"enumDescriptions": [ +"Default value. If unspecified, the default behavior is: - DANGEROUS_CONTENT: BLOCK_FEW - SEXUALLY_EXPLICIT: BLOCK_SOME - HARASSMENT: BLOCK_SOME - HATE_SPEECH: BLOCK_SOME", +"Block most potentially sensitive responses.", +"Block some potentially sensitive responses.", +"Block a few potentially sensitive responses.", +"No filtering for this category." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1ReloadDocumentRequest": { "description": "Request message for Documents.ReloadDocument.", "id": "GoogleCloudDialogflowV2beta1ReloadDocumentRequest", @@ -23023,6 +23599,22 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1SuggestionDedupingConfig": { +"description": "Config for suggestion deduping. NEXT_ID: 3", +"id": "GoogleCloudDialogflowV2beta1SuggestionDedupingConfig", +"properties": { +"enableDeduping": { +"description": "Optional. Whether to enable suggestion deduping.", +"type": "boolean" +}, +"similarityThreshold": { +"description": "Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1SuggestionFaqAnswer": { "description": "Represents suggested answer from \"frequently asked questions\".", "id": "GoogleCloudDialogflowV2beta1SuggestionFaqAnswer", @@ -23090,11 +23682,27 @@ true "type": "object" }, "GoogleCloudDialogflowV2beta1SuggestionInput": { -"description": "Represents the selection of a suggestion.", +"description": "Represents the action to take for a tool call that requires confirmation.", "id": "GoogleCloudDialogflowV2beta1SuggestionInput", "properties": { +"action": { +"description": "Optional. The type of action to take with the tool.", +"enum": [ +"ACTION_UNSPECIFIED", +"CANCEL", +"REVISE", +"CONFIRM" +], +"enumDescriptions": [ +"Action not specified.", +"Indicates the user chooses to not make the tool call. It is only applicable to tool calls that are waiting for user confirmation.", +"Makes the tool call with provided parameters. This action is intended for tool calls that only read but not write data.", +"Makes the tool call with provided parameters. This action is intended for tool calls that may write data." +], +"type": "string" +}, "answerRecord": { -"description": "Required. The ID of a suggestion selected by the human agent. The suggestion(s) were generated in a previous call to request Dialogflow assist. The format is: `projects//locations//answerRecords/` where is an alphanumeric string.", +"description": "Required. Format: `projects//locations//answerRecords/` The answer record associated with the tool call.", "type": "string" }, "intentInput": { @@ -23106,9 +23714,14 @@ true "description": "Properties of the object.", "type": "any" }, -"description": "In Dialogflow assist for v3, the user can submit a form by sending a SuggestionInput. The form is uniquely determined by the answer_record field, which identifies a v3 QueryResult containing the current page. The form parameters are specified via the parameters field. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", +"description": "Parameters to be used for the tool call. If not provided, the tool will be called without any parameters.", "type": "object" }, +"sendTime": { +"description": "Optional. Time when the current suggest input is sent. For tool calls, this timestamp (along with the answer record) will be included in the corresponding tool call result so that it can be identified.", +"format": "google-datetime", +"type": "string" +}, "textOverride": { "$ref": "GoogleCloudDialogflowV2beta1TextInput", "description": "Optional. If the customer edited the suggestion before using it, include the revised text here." @@ -23770,6 +24383,10 @@ true "description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, +"answerRecord": { +"description": "Optional. The answer record associated with this tool call.", +"type": "string" +}, "createTime": { "description": "Output only. Create time of the tool call.", "format": "google-datetime", @@ -23784,9 +24401,32 @@ true "description": "Optional. The action's input parameters.", "type": "object" }, +"state": { +"description": "Output only. State of the tool call", +"enum": [ +"STATE_UNSPECIFIED", +"TRIGGERED", +"NEEDS_CONFIRMATION" +], +"enumDescriptions": [ +"Default value.", +"The tool call has been triggered.", +"The tool call requires confirmation from a human." +], +"readOnly": true, +"type": "string" +}, "tool": { "description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" +}, +"toolDisplayDetails": { +"description": "Optional. A human readable description of the tool.", +"type": "string" +}, +"toolDisplayName": { +"description": "Optional. A human readable short name of the tool, to be shown on the UI.", +"type": "string" } }, "type": "object" @@ -23799,6 +24439,10 @@ true "description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, +"answerRecord": { +"description": "Optional. The answer record associated with this tool call result.", +"type": "string" +}, "content": { "description": "Only populated if the response content is utf-8 encoded.", "type": "string" @@ -24202,6 +24846,13 @@ true "$ref": "GoogleLongrunningOperation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3.json b/googleapiclient/discovery_cache/documents/dialogflow.v3.json index 67e9c0fb5c..4cdfab79d1 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3.json @@ -5036,6 +5036,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v3/{+name}/operations", @@ -5293,6 +5298,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v3/{+name}/operations", @@ -5309,7 +5319,7 @@ } } }, -"revision": "20250919", +"revision": "20250929", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3Action": { @@ -14968,6 +14978,207 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2AgentCoachingInstruction": { +"description": "Agent Coaching instructions that customer can configure.", +"id": "GoogleCloudDialogflowV2AgentCoachingInstruction", +"properties": { +"agentAction": { +"description": "Optional. The action that human agent should take. For example, \"apologize for the slow shipping\". If the users only want to use agent coaching for intent detection, agent_action can be empty", +"type": "string" +}, +"condition": { +"description": "Optional. The condition of the instruction. For example, \"the customer wants to cancel an order\". If the users want the instruction to be triggered unconditionally, the condition can be empty.", +"type": "string" +}, +"displayDetails": { +"description": "Optional. The detailed description of this instruction.", +"type": "string" +}, +"displayName": { +"description": "Optional. Display name for the instruction.", +"type": "string" +}, +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult", +"description": "Output only. Duplication check for the AgentCoachingInstruction.", +"readOnly": true +}, +"systemAction": { +"description": "Optional. The action that system should take. For example, \"call GetOrderTime with order_number={order number provided by the customer}\". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult": { +"description": "Duplication check for the suggestion.", +"id": "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult", +"properties": { +"duplicateSuggestions": { +"description": "Output only. The duplicate suggestions.", +"items": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion": { +"description": "The duplicate suggestion details.", +"id": "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion", +"properties": { +"answerRecord": { +"description": "Output only. The answer record id of the past duplicate suggestion.", +"readOnly": true, +"type": "string" +}, +"similarityScore": { +"description": "Output only. The similarity score of between the past and current suggestion.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"suggestionIndex": { +"description": "Output only. The index of the duplicate suggestion in the past suggestion list.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestion": { +"description": "Suggestion for coaching agents.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestion", +"properties": { +"agentActionSuggestions": { +"description": "Optional. Suggested actions for the agent to take.", +"items": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion" +}, +"type": "array" +}, +"applicableInstructions": { +"description": "Optional. Instructions applicable based on the current context.", +"items": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingInstruction" +}, +"type": "array" +}, +"sampleResponses": { +"description": "Optional. Sample response for the Agent.", +"items": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion": { +"description": "Actions suggested for the agent. This is based on applicable instructions.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion", +"properties": { +"agentAction": { +"description": "Optional. The suggested action for the agent.", +"type": "string" +}, +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult", +"description": "Output only. Duplicate check result for the agent action suggestion.", +"readOnly": true +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionSources", +"description": "Output only. Sources for the agent action suggestion.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult": { +"description": "Duplication check for the suggestion.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult", +"properties": { +"duplicateSuggestions": { +"description": "Output only. The duplicate suggestions.", +"items": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion": { +"description": "The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion", +"properties": { +"answerRecord": { +"description": "Output only. The answer record id of the past duplicate suggestion.", +"readOnly": true, +"type": "string" +}, +"similarityScore": { +"description": "Output only. The similarity score of between the past and current suggestion.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionSources", +"description": "Output only. Sources for the suggestion.", +"readOnly": true +}, +"suggestionIndex": { +"description": "Output only. The index of the duplicate suggestion in the past suggestion list.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse": { +"description": "Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse", +"properties": { +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult", +"description": "Output only. Duplicate check result for the sample response.", +"readOnly": true +}, +"responseText": { +"description": "Optional. Sample response for Agent in text.", +"type": "string" +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionSources", +"description": "Output only. Sources for the Sample Response.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestionSources": { +"description": "Sources for the suggestion.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestionSources", +"properties": { +"instructionIndexes": { +"description": "Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field.", +"items": { +"format": "int32", +"type": "integer" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2AnnotatedMessagePart": { "description": "Represents a part of a message possibly annotated with an entity. The part can be an entity or purely a part of the message between two entities or message start/end.", "id": "GoogleCloudDialogflowV2AnnotatedMessagePart", @@ -15651,6 +15862,10 @@ false "description": "Suggestion generated using a Generator.", "id": "GoogleCloudDialogflowV2GeneratorSuggestion", "properties": { +"agentCoachingSuggestion": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestion", +"description": "Optional. Suggestion to coach the agent." +}, "freeFormSuggestion": { "$ref": "GoogleCloudDialogflowV2FreeFormSuggestion", "description": "Optional. Free form suggestion." @@ -17431,6 +17646,10 @@ true "description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, +"answerRecord": { +"description": "Optional. The answer record associated with this tool call.", +"type": "string" +}, "createTime": { "description": "Output only. Create time of the tool call.", "format": "google-datetime", @@ -17445,9 +17664,32 @@ true "description": "Optional. The action's input parameters.", "type": "object" }, +"state": { +"description": "Output only. State of the tool call.", +"enum": [ +"STATE_UNSPECIFIED", +"TRIGGERED", +"NEEDS_CONFIRMATION" +], +"enumDescriptions": [ +"Default value.", +"The tool call has been triggered.", +"The tool call requires confirmation from a human." +], +"readOnly": true, +"type": "string" +}, "tool": { "description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" +}, +"toolDisplayDetails": { +"description": "Optional. A human readable description of the tool.", +"type": "string" +}, +"toolDisplayName": { +"description": "Optional. A human readable short name of the tool, to be shown on the UI.", +"type": "string" } }, "type": "object" @@ -17460,6 +17702,10 @@ true "description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, +"answerRecord": { +"description": "Optional. The answer record associated with this tool call result.", +"type": "string" +}, "content": { "description": "Only populated if the response content is utf-8 encoded.", "type": "string" @@ -17589,6 +17835,207 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1AgentCoachingInstruction": { +"description": "Agent Coaching instructions that customer can configure.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingInstruction", +"properties": { +"agentAction": { +"description": "Optional. The action that human agent should take. For example, \"apologize for the slow shipping\". If the users only want to use agent coaching for intent detection, agent_action can be empty", +"type": "string" +}, +"condition": { +"description": "Optional. The condition of the instruction. For example, \"the customer wants to cancel an order\". If the users want the instruction to be triggered unconditionally, the condition can be empty.", +"type": "string" +}, +"displayDetails": { +"description": "Optional. The detailed description of this instruction.", +"type": "string" +}, +"displayName": { +"description": "Optional. Display name for the instruction.", +"type": "string" +}, +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult", +"description": "Output only. Duplication check for the AgentCoachingInstruction.", +"readOnly": true +}, +"systemAction": { +"description": "Optional. The action that system should take. For example, \"call GetOrderTime with order_number={order number provided by the customer}\". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult": { +"description": "Duplication check for the suggestion.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult", +"properties": { +"duplicateSuggestions": { +"description": "Output only. The duplicate suggestions.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion": { +"description": "The duplicate suggestion details.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion", +"properties": { +"answerRecord": { +"description": "Output only. The answer record id of the past duplicate suggestion.", +"readOnly": true, +"type": "string" +}, +"similarityScore": { +"description": "Output only. The similarity score of between the past and current suggestion.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"suggestionIndex": { +"description": "Output only. The index of the duplicate suggestion in the past suggestion list.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestion": { +"description": "Suggestion for coaching agents.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestion", +"properties": { +"agentActionSuggestions": { +"description": "Optional. Suggested actions for the agent to take.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion" +}, +"type": "array" +}, +"applicableInstructions": { +"description": "Optional. Instructions applicable based on the current context.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingInstruction" +}, +"type": "array" +}, +"sampleResponses": { +"description": "Optional. Sample response for the Agent.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion": { +"description": "Actions suggested for the agent. This is based on applicable instructions.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion", +"properties": { +"agentAction": { +"description": "Optional. The suggested action for the agent.", +"type": "string" +}, +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult", +"description": "Output only. Duplicate check result for the agent action suggestion.", +"readOnly": true +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources", +"description": "Output only. Sources for the agent action suggestion.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult": { +"description": "Duplication check for the suggestion.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult", +"properties": { +"duplicateSuggestions": { +"description": "Output only. The duplicate suggestions.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion": { +"description": "The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion", +"properties": { +"answerRecord": { +"description": "Output only. The answer record id of the past duplicate suggestion.", +"readOnly": true, +"type": "string" +}, +"similarityScore": { +"description": "Output only. The similarity score of between the past and current suggestion.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources", +"description": "Output only. Sources for the suggestion.", +"readOnly": true +}, +"suggestionIndex": { +"description": "Output only. The index of the duplicate suggestion in the past suggestion list.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse": { +"description": "Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse", +"properties": { +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult", +"description": "Output only. Duplicate check result for the sample response.", +"readOnly": true +}, +"responseText": { +"description": "Optional. Sample response for Agent in text.", +"type": "string" +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources", +"description": "Output only. Sources for the Sample Response.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources": { +"description": "Sources for the suggestion.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources", +"properties": { +"instructionIndexes": { +"description": "Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field.", +"items": { +"format": "int32", +"type": "integer" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1AnnotatedMessagePart": { "description": "Represents a part of a message possibly annotated with an entity. The part can be an entity or purely a part of the message between two entities or message start/end.", "id": "GoogleCloudDialogflowV2beta1AnnotatedMessagePart", @@ -18048,6 +18495,10 @@ true "description": "Suggestion generated using a Generator.", "id": "GoogleCloudDialogflowV2beta1GeneratorSuggestion", "properties": { +"agentCoachingSuggestion": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestion", +"description": "Optional. Suggestion to coach the agent." +}, "freeFormSuggestion": { "$ref": "GoogleCloudDialogflowV2beta1FreeFormSuggestion", "description": "Optional. Free form suggestion." @@ -20354,6 +20805,10 @@ true "description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, +"answerRecord": { +"description": "Optional. The answer record associated with this tool call.", +"type": "string" +}, "createTime": { "description": "Output only. Create time of the tool call.", "format": "google-datetime", @@ -20368,9 +20823,32 @@ true "description": "Optional. The action's input parameters.", "type": "object" }, +"state": { +"description": "Output only. State of the tool call", +"enum": [ +"STATE_UNSPECIFIED", +"TRIGGERED", +"NEEDS_CONFIRMATION" +], +"enumDescriptions": [ +"Default value.", +"The tool call has been triggered.", +"The tool call requires confirmation from a human." +], +"readOnly": true, +"type": "string" +}, "tool": { "description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" +}, +"toolDisplayDetails": { +"description": "Optional. A human readable description of the tool.", +"type": "string" +}, +"toolDisplayName": { +"description": "Optional. A human readable short name of the tool, to be shown on the UI.", +"type": "string" } }, "type": "object" @@ -20383,6 +20861,10 @@ true "description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, +"answerRecord": { +"description": "Optional. The answer record associated with this tool call result.", +"type": "string" +}, "content": { "description": "Only populated if the response content is utf-8 encoded.", "type": "string" @@ -20652,6 +21134,13 @@ true "$ref": "GoogleLongrunningOperation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json index d2a81e294f..4242714b86 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json @@ -5163,6 +5163,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v3beta1/{+name}/operations", @@ -5420,6 +5425,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v3beta1/{+name}/operations", @@ -5436,7 +5446,7 @@ } } }, -"revision": "20250919", +"revision": "20250929", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -16169,6 +16179,207 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2AgentCoachingInstruction": { +"description": "Agent Coaching instructions that customer can configure.", +"id": "GoogleCloudDialogflowV2AgentCoachingInstruction", +"properties": { +"agentAction": { +"description": "Optional. The action that human agent should take. For example, \"apologize for the slow shipping\". If the users only want to use agent coaching for intent detection, agent_action can be empty", +"type": "string" +}, +"condition": { +"description": "Optional. The condition of the instruction. For example, \"the customer wants to cancel an order\". If the users want the instruction to be triggered unconditionally, the condition can be empty.", +"type": "string" +}, +"displayDetails": { +"description": "Optional. The detailed description of this instruction.", +"type": "string" +}, +"displayName": { +"description": "Optional. Display name for the instruction.", +"type": "string" +}, +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult", +"description": "Output only. Duplication check for the AgentCoachingInstruction.", +"readOnly": true +}, +"systemAction": { +"description": "Optional. The action that system should take. For example, \"call GetOrderTime with order_number={order number provided by the customer}\". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult": { +"description": "Duplication check for the suggestion.", +"id": "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult", +"properties": { +"duplicateSuggestions": { +"description": "Output only. The duplicate suggestions.", +"items": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion": { +"description": "The duplicate suggestion details.", +"id": "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion", +"properties": { +"answerRecord": { +"description": "Output only. The answer record id of the past duplicate suggestion.", +"readOnly": true, +"type": "string" +}, +"similarityScore": { +"description": "Output only. The similarity score of between the past and current suggestion.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"suggestionIndex": { +"description": "Output only. The index of the duplicate suggestion in the past suggestion list.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestion": { +"description": "Suggestion for coaching agents.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestion", +"properties": { +"agentActionSuggestions": { +"description": "Optional. Suggested actions for the agent to take.", +"items": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion" +}, +"type": "array" +}, +"applicableInstructions": { +"description": "Optional. Instructions applicable based on the current context.", +"items": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingInstruction" +}, +"type": "array" +}, +"sampleResponses": { +"description": "Optional. Sample response for the Agent.", +"items": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion": { +"description": "Actions suggested for the agent. This is based on applicable instructions.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion", +"properties": { +"agentAction": { +"description": "Optional. The suggested action for the agent.", +"type": "string" +}, +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult", +"description": "Output only. Duplicate check result for the agent action suggestion.", +"readOnly": true +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionSources", +"description": "Output only. Sources for the agent action suggestion.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult": { +"description": "Duplication check for the suggestion.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult", +"properties": { +"duplicateSuggestions": { +"description": "Output only. The duplicate suggestions.", +"items": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion": { +"description": "The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion", +"properties": { +"answerRecord": { +"description": "Output only. The answer record id of the past duplicate suggestion.", +"readOnly": true, +"type": "string" +}, +"similarityScore": { +"description": "Output only. The similarity score of between the past and current suggestion.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionSources", +"description": "Output only. Sources for the suggestion.", +"readOnly": true +}, +"suggestionIndex": { +"description": "Output only. The index of the duplicate suggestion in the past suggestion list.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse": { +"description": "Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse", +"properties": { +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult", +"description": "Output only. Duplicate check result for the sample response.", +"readOnly": true +}, +"responseText": { +"description": "Optional. Sample response for Agent in text.", +"type": "string" +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionSources", +"description": "Output only. Sources for the Sample Response.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2AgentCoachingSuggestionSources": { +"description": "Sources for the suggestion.", +"id": "GoogleCloudDialogflowV2AgentCoachingSuggestionSources", +"properties": { +"instructionIndexes": { +"description": "Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field.", +"items": { +"format": "int32", +"type": "integer" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2AnnotatedMessagePart": { "description": "Represents a part of a message possibly annotated with an entity. The part can be an entity or purely a part of the message between two entities or message start/end.", "id": "GoogleCloudDialogflowV2AnnotatedMessagePart", @@ -16852,6 +17063,10 @@ false "description": "Suggestion generated using a Generator.", "id": "GoogleCloudDialogflowV2GeneratorSuggestion", "properties": { +"agentCoachingSuggestion": { +"$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestion", +"description": "Optional. Suggestion to coach the agent." +}, "freeFormSuggestion": { "$ref": "GoogleCloudDialogflowV2FreeFormSuggestion", "description": "Optional. Free form suggestion." @@ -18632,6 +18847,10 @@ true "description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, +"answerRecord": { +"description": "Optional. The answer record associated with this tool call.", +"type": "string" +}, "createTime": { "description": "Output only. Create time of the tool call.", "format": "google-datetime", @@ -18646,9 +18865,32 @@ true "description": "Optional. The action's input parameters.", "type": "object" }, +"state": { +"description": "Output only. State of the tool call.", +"enum": [ +"STATE_UNSPECIFIED", +"TRIGGERED", +"NEEDS_CONFIRMATION" +], +"enumDescriptions": [ +"Default value.", +"The tool call has been triggered.", +"The tool call requires confirmation from a human." +], +"readOnly": true, +"type": "string" +}, "tool": { "description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" +}, +"toolDisplayDetails": { +"description": "Optional. A human readable description of the tool.", +"type": "string" +}, +"toolDisplayName": { +"description": "Optional. A human readable short name of the tool, to be shown on the UI.", +"type": "string" } }, "type": "object" @@ -18661,6 +18903,10 @@ true "description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, +"answerRecord": { +"description": "Optional. The answer record associated with this tool call result.", +"type": "string" +}, "content": { "description": "Only populated if the response content is utf-8 encoded.", "type": "string" @@ -18790,6 +19036,207 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1AgentCoachingInstruction": { +"description": "Agent Coaching instructions that customer can configure.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingInstruction", +"properties": { +"agentAction": { +"description": "Optional. The action that human agent should take. For example, \"apologize for the slow shipping\". If the users only want to use agent coaching for intent detection, agent_action can be empty", +"type": "string" +}, +"condition": { +"description": "Optional. The condition of the instruction. For example, \"the customer wants to cancel an order\". If the users want the instruction to be triggered unconditionally, the condition can be empty.", +"type": "string" +}, +"displayDetails": { +"description": "Optional. The detailed description of this instruction.", +"type": "string" +}, +"displayName": { +"description": "Optional. Display name for the instruction.", +"type": "string" +}, +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult", +"description": "Output only. Duplication check for the AgentCoachingInstruction.", +"readOnly": true +}, +"systemAction": { +"description": "Optional. The action that system should take. For example, \"call GetOrderTime with order_number={order number provided by the customer}\". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult": { +"description": "Duplication check for the suggestion.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult", +"properties": { +"duplicateSuggestions": { +"description": "Output only. The duplicate suggestions.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion": { +"description": "The duplicate suggestion details.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion", +"properties": { +"answerRecord": { +"description": "Output only. The answer record id of the past duplicate suggestion.", +"readOnly": true, +"type": "string" +}, +"similarityScore": { +"description": "Output only. The similarity score of between the past and current suggestion.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"suggestionIndex": { +"description": "Output only. The index of the duplicate suggestion in the past suggestion list.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestion": { +"description": "Suggestion for coaching agents.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestion", +"properties": { +"agentActionSuggestions": { +"description": "Optional. Suggested actions for the agent to take.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion" +}, +"type": "array" +}, +"applicableInstructions": { +"description": "Optional. Instructions applicable based on the current context.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingInstruction" +}, +"type": "array" +}, +"sampleResponses": { +"description": "Optional. Sample response for the Agent.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion": { +"description": "Actions suggested for the agent. This is based on applicable instructions.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion", +"properties": { +"agentAction": { +"description": "Optional. The suggested action for the agent.", +"type": "string" +}, +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult", +"description": "Output only. Duplicate check result for the agent action suggestion.", +"readOnly": true +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources", +"description": "Output only. Sources for the agent action suggestion.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult": { +"description": "Duplication check for the suggestion.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult", +"properties": { +"duplicateSuggestions": { +"description": "Output only. The duplicate suggestions.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion": { +"description": "The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion", +"properties": { +"answerRecord": { +"description": "Output only. The answer record id of the past duplicate suggestion.", +"readOnly": true, +"type": "string" +}, +"similarityScore": { +"description": "Output only. The similarity score of between the past and current suggestion.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources", +"description": "Output only. Sources for the suggestion.", +"readOnly": true +}, +"suggestionIndex": { +"description": "Output only. The index of the duplicate suggestion in the past suggestion list.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse": { +"description": "Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse", +"properties": { +"duplicateCheckResult": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult", +"description": "Output only. Duplicate check result for the sample response.", +"readOnly": true +}, +"responseText": { +"description": "Optional. Sample response for Agent in text.", +"type": "string" +}, +"sources": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources", +"description": "Output only. Sources for the Sample Response.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources": { +"description": "Sources for the suggestion.", +"id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources", +"properties": { +"instructionIndexes": { +"description": "Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field.", +"items": { +"format": "int32", +"type": "integer" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1AnnotatedMessagePart": { "description": "Represents a part of a message possibly annotated with an entity. The part can be an entity or purely a part of the message between two entities or message start/end.", "id": "GoogleCloudDialogflowV2beta1AnnotatedMessagePart", @@ -19249,6 +19696,10 @@ true "description": "Suggestion generated using a Generator.", "id": "GoogleCloudDialogflowV2beta1GeneratorSuggestion", "properties": { +"agentCoachingSuggestion": { +"$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestion", +"description": "Optional. Suggestion to coach the agent." +}, "freeFormSuggestion": { "$ref": "GoogleCloudDialogflowV2beta1FreeFormSuggestion", "description": "Optional. Free form suggestion." @@ -21555,6 +22006,10 @@ true "description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, +"answerRecord": { +"description": "Optional. The answer record associated with this tool call.", +"type": "string" +}, "createTime": { "description": "Output only. Create time of the tool call.", "format": "google-datetime", @@ -21569,9 +22024,32 @@ true "description": "Optional. The action's input parameters.", "type": "object" }, +"state": { +"description": "Output only. State of the tool call", +"enum": [ +"STATE_UNSPECIFIED", +"TRIGGERED", +"NEEDS_CONFIRMATION" +], +"enumDescriptions": [ +"Default value.", +"The tool call has been triggered.", +"The tool call requires confirmation from a human." +], +"readOnly": true, +"type": "string" +}, "tool": { "description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" +}, +"toolDisplayDetails": { +"description": "Optional. A human readable description of the tool.", +"type": "string" +}, +"toolDisplayName": { +"description": "Optional. A human readable short name of the tool, to be shown on the UI.", +"type": "string" } }, "type": "object" @@ -21584,6 +22062,10 @@ true "description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, +"answerRecord": { +"description": "Optional. The answer record associated with this tool call result.", +"type": "string" +}, "content": { "description": "Only populated if the response content is utf-8 encoded.", "type": "string" @@ -21853,6 +22335,13 @@ true "$ref": "GoogleLongrunningOperation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index 83470b039e..f51c18afdb 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -7138,6 +7138,102 @@ } } }, +"licenseConfigs": { +"methods": { +"create": { +"description": "Creates a LicenseConfig", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/licenseConfigs", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.licenseConfigs.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"licenseConfigId": { +"description": "Optional. The ID to use for the LicenseConfig, which will become the final component of the LicenseConfig's resource name. We are using the tier (product edition) name as the license config id such as `search` or `search_and_assistant`.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/licenseConfigs", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1LicenseConfig" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1LicenseConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a LicenseConfig.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/licenseConfigs/{licenseConfigsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.licenseConfigs.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of LicenseConfig, such as `projects/{project}/locations/{location}/licenseConfigs/*`. If the caller does not have permission to access the LicenseConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested LicenseConfig does not exist, a NOT_FOUND error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/licenseConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1LicenseConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the LicenseConfig", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/licenseConfigs/{licenseConfigsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.licenseConfigs.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/licenseConfigs/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Indicates which fields in the provided LicenseConfig to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1LicenseConfig" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1LicenseConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "operations": { "methods": { "get": { @@ -7571,7 +7667,7 @@ } } }, -"revision": "20250924", +"revision": "20250929", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -8834,6 +8930,67 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig": { +"description": "The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.", +"id": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig", +"properties": { +"alertEnrollments": { +"description": "Optional. The enrollment state of each alert.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment" +}, +"type": "array" +}, +"alertPolicy": { +"description": "Immutable. The fully qualified resource name of the AlertPolicy.", +"type": "string" +}, +"contactDetails": { +"description": "Optional. The contact details for each alert policy.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1ContactDetails" +}, +"type": "array" +}, +"languageCode": { +"description": "Optional. The language code used for notifications", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment": { +"description": "The alert enrollment status.", +"id": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment", +"properties": { +"alertId": { +"description": "Immutable. The id of an alert.", +"type": "string" +}, +"enrollState": { +"description": "Required. The enrollment status of a customer.", +"enum": [ +"ENROLL_STATE_UNSPECIFIED", +"ENROLLED", +"DECLINED" +], +"enumDescriptions": [ +"Default value. Used for customers who have not responded to the alert policy.", +"Customer is enrolled in this policy.", +"Customer declined this policy." +], +"type": "string" +}, +"notificationParams": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1AlloyDbSource": { "description": "AlloyDB source import data from.", "id": "GoogleCloudDiscoveryengineV1AlloyDbSource", @@ -11619,6 +11776,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1ContactDetails": { +"description": "The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.", +"id": "GoogleCloudDiscoveryengineV1ContactDetails", +"properties": { +"emailAddress": { +"description": "Optional. The email address of the contact.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1Control": { "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", "id": "GoogleCloudDiscoveryengineV1Control", @@ -12697,7 +12865,7 @@ "readOnly": true }, "configurableBillingApproach": { -"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", +"description": "Optional. Configuration for configurable billing approach. See", "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", @@ -13475,7 +13643,7 @@ "description": "Common config spec that specifies the metadata of the engine." }, "configurableBillingApproach": { -"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.", +"description": "Optional. Configuration for configurable billing approach.", "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_BILLING_APPROACH_ENABLED" @@ -13521,7 +13689,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`", "type": "object" }, "industryVertical": { @@ -14533,6 +14701,107 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1LicenseConfig": { +"description": "Information about users' licenses.", +"id": "GoogleCloudDiscoveryengineV1LicenseConfig", +"properties": { +"alertPolicyResourceConfig": { +"$ref": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig", +"description": "Optional. The alert policy config for this license config." +}, +"autoRenew": { +"description": "Optional. Whether the license config should be auto renewed when it reaches the end date.", +"type": "boolean" +}, +"endDate": { +"$ref": "GoogleTypeDate", +"description": "Optional. The planed end date." +}, +"freeTrial": { +"description": "Optional. Whether the license config is for free trial.", +"type": "boolean" +}, +"licenseCount": { +"description": "Required. Number of licenses purchased.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`", +"type": "string" +}, +"startDate": { +"$ref": "GoogleTypeDate", +"description": "Required. The start date." +}, +"state": { +"description": "Output only. The state of the license config.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"EXPIRED", +"NOT_STARTED" +], +"enumDescriptions": [ +"Default value. The license config does not exist.", +"The license config is effective and being used.", +"The license config has expired.", +"The license config has not started yet, and its start date is in the future." +], +"readOnly": true, +"type": "string" +}, +"subscriptionTerm": { +"description": "Required. Subscription term.", +"enum": [ +"SUBSCRIPTION_TERM_UNSPECIFIED", +"SUBSCRIPTION_TERM_ONE_MONTH", +"SUBSCRIPTION_TERM_ONE_YEAR", +"SUBSCRIPTION_TERM_THREE_YEARS" +], +"enumDescriptions": [ +"Default value, do not use.", +"1 month.", +"1 year.", +"3 years." +], +"type": "string" +}, +"subscriptionTier": { +"description": "Required. Subscription tier information for the license config.", +"enum": [ +"SUBSCRIPTION_TIER_UNSPECIFIED", +"SUBSCRIPTION_TIER_SEARCH", +"SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT", +"SUBSCRIPTION_TIER_NOTEBOOK_LM", +"SUBSCRIPTION_TIER_FRONTLINE_WORKER", +"SUBSCRIPTION_TIER_AGENTSPACE_STARTER", +"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS", +"SUBSCRIPTION_TIER_ENTERPRISE", +"SUBSCRIPTION_TIER_EDU", +"SUBSCRIPTION_TIER_EDU_PRO", +"SUBSCRIPTION_TIER_EDU_EMERGING", +"SUBSCRIPTION_TIER_EDU_PRO_EMERGING" +], +"enumDescriptions": [ +"Default value.", +"Search tier. Search tier can access VAIS search features and NotebookLM features.", +"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.", +"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.", +"Frontline worker tier.", +"Agentspace Starter tier.", +"Agentspace Business tier.", +"Enterprise tier.", +"EDU tier.", +"EDU Pro tier.", +"EDU emerging market tier.", +"EDU Pro emerging market tier." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1ListCmekConfigsResponse": { "description": "Response message for CmekConfigService.ListCmekConfigs method.", "id": "GoogleCloudDiscoveryengineV1ListCmekConfigsResponse", @@ -16999,6 +17268,11 @@ false "description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.", "readOnly": true }, +"detailedAssistAnswer": { +"$ref": "GoogleCloudDiscoveryengineV1AssistAnswer", +"description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session.", +"readOnly": true +}, "query": { "$ref": "GoogleCloudDiscoveryengineV1Query", "description": "Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn" @@ -17950,6 +18224,67 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig": { +"description": "The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.", +"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig", +"properties": { +"alertEnrollments": { +"description": "Optional. The enrollment state of each alert.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment" +}, +"type": "array" +}, +"alertPolicy": { +"description": "Immutable. The fully qualified resource name of the AlertPolicy.", +"type": "string" +}, +"contactDetails": { +"description": "Optional. The contact details for each alert policy.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaContactDetails" +}, +"type": "array" +}, +"languageCode": { +"description": "Optional. The language code used for notifications", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment": { +"description": "The alert enrollment status.", +"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment", +"properties": { +"alertId": { +"description": "Immutable. The id of an alert.", +"type": "string" +}, +"enrollState": { +"description": "Required. The enrollment status of a customer.", +"enum": [ +"ENROLL_STATE_UNSPECIFIED", +"ENROLLED", +"DECLINED" +], +"enumDescriptions": [ +"Default value. Used for customers who have not responded to the alert policy.", +"Customer is enrolled in this policy.", +"Customer declined this policy." +], +"type": "string" +}, +"notificationParams": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAnswer": { "description": "Defines an answer.", "id": "GoogleCloudDiscoveryengineV1alphaAnswer", @@ -18574,47 +18909,412 @@ false }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaBAPConfig": { -"description": "The configuration for the BAP connector.", -"id": "GoogleCloudDiscoveryengineV1alphaBAPConfig", +"GoogleCloudDiscoveryengineV1alphaAssistAnswer": { +"description": "AssistAnswer resource, main part of AssistResponse.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistAnswer", "properties": { -"enabledActions": { -"description": "Optional. The actions enabled on the associated BAP connection.", -"items": { -"type": "string" -}, -"type": "array" -}, -"supportedConnectorModes": { -"description": "Required. The supported connector modes for the associated BAP connection.", +"assistSkippedReasons": { +"description": "Reasons for not answering the assist call.", "items": { "enum": [ -"CONNECTOR_MODE_UNSPECIFIED", -"DATA_INGESTION", -"ACTIONS", -"END_USER_AUTHENTICATION" +"ASSIST_SKIPPED_REASON_UNSPECIFIED", +"NON_ASSIST_SEEKING_QUERY_IGNORED", +"CUSTOMER_POLICY_VIOLATION" ], "enumDescriptions": [ -"Connector mode unspecified.", -"Connector utilized for data ingestion.", -"Connector utilized for Actions", -"Connector utilized for End User Authentication." +"Default value. Skip reason is not specified.", +"The assistant ignored the query, because it did not appear to be answer-seeking.", +"The assistant ignored the query or refused to answer because of a customer policy violation (e.g., the query or the answer contained a banned phrase)." ], "type": "string" }, "type": "array" -} }, -"type": "object" +"customerPolicyEnforcementResult": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult", +"description": "Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation." }, -"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"name": { +"description": "Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"replies": { +"description": "Replies of the assistant.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerReply" +}, +"type": "array" +}, +"state": { +"description": "State of the answer generation.", +"enum": [ +"STATE_UNSPECIFIED", +"IN_PROGRESS", +"FAILED", +"SUCCEEDED", +"SKIPPED" +], +"enumDescriptions": [ +"Unknown.", +"Assist operation is currently in progress.", +"Assist operation has failed.", +"Assist operation has succeeded.", +"Assist operation has been skipped." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult": { +"description": "Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult", +"properties": { +"policyResults": { +"description": "Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult" +}, +"type": "array" +}, +"verdict": { +"description": "Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK.", +"enum": [ +"UNSPECIFIED", +"ALLOW", +"BLOCK" +], +"enumDescriptions": [ +"Unknown value.", +"There was no policy violation.", +"Processing was blocked by the customer policy." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult": { +"description": "Customer policy enforcement result for the banned phrase policy.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult", +"properties": { +"bannedPhrases": { +"description": "The banned phrases that were found in the query or the answer.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult": { +"description": "Customer policy enforcement result for the Model Armor policy.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult", +"properties": { +"error": { +"$ref": "GoogleRpcStatus", +"description": "The error returned by Model Armor if the policy enforcement failed for some reason." +}, +"modelArmorViolation": { +"description": "The Model Armor violation that was found.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult": { +"description": "Customer policy enforcement result for a single policy type.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult", +"properties": { +"bannedPhraseEnforcementResult": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult", +"description": "The policy enforcement result for the banned phrase policy." +}, +"modelArmorEnforcementResult": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult", +"description": "The policy enforcement result for the Model Armor policy." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistAnswerReply": { +"description": "One part of the multi-part response of the assist call.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerReply", +"properties": { +"groundedContent": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent", +"description": "Possibly grounded response text or media from the assistant." +}, +"replyId": { +"description": "Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantContent": { +"description": "Multi-modal content.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantContent", +"properties": { +"codeExecutionResult": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult", +"description": "Result of executing an ExecutableCode." +}, +"executableCode": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode", +"description": "Code generated by the model that is meant to be executed." +}, +"file": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContentFile", +"description": "A file, e.g., an audio summary." +}, +"inlineData": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContentBlob", +"description": "Inline binary data." +}, +"role": { +"description": "The producer of the content. Can be \"model\" or \"user\".", +"type": "string" +}, +"text": { +"description": "Inline text.", +"type": "string" +}, +"thought": { +"description": "Optional. Indicates if the part is thought from the model.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantContentBlob": { +"description": "Inline blob.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantContentBlob", +"properties": { +"data": { +"description": "Required. Raw bytes.", +"format": "byte", +"type": "string" +}, +"mimeType": { +"description": "Required. The media type (MIME type) of the generated data.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult": { +"description": "Result of executing ExecutableCode.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult", +"properties": { +"outcome": { +"description": "Required. Outcome of the code execution.", +"enum": [ +"OUTCOME_UNSPECIFIED", +"OUTCOME_OK", +"OUTCOME_FAILED", +"OUTCOME_DEADLINE_EXCEEDED" +], +"enumDescriptions": [ +"Unspecified status. This value should not be used.", +"Code execution completed successfully.", +"Code execution finished but with a failure. `stderr` should contain the reason.", +"Code execution ran for too long, and was cancelled. There may or may not be a partial output present." +], +"type": "string" +}, +"output": { +"description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode": { +"description": "Code generated by the model that is meant to be executed by the model.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode", +"properties": { +"code": { +"description": "Required. The code content. Currently only supports Python.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantContentFile": { +"description": "A file, e.g., an audio summary.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantContentFile", +"properties": { +"fileId": { +"description": "Required. The file ID.", +"type": "string" +}, +"mimeType": { +"description": "Required. The media type (MIME type) of the file.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent": { +"description": "A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like \"Of course, I will gladly search it for you.\" do not need grounding.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent", +"properties": { +"content": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContent", +"description": "The content." +}, +"textGroundingMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata", +"description": "Metadata for grounding based on text sources." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata": { +"description": "Grounding details for text sources.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata", +"properties": { +"references": { +"description": "References for the grounded text.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference" +}, +"type": "array" +}, +"segments": { +"description": "Grounding information for parts of the text.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference": { +"description": "Referenced content and related document metadata.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference", +"properties": { +"content": { +"description": "Referenced text content.", +"type": "string" +}, +"documentMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata", +"description": "Document metadata." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata": { +"description": "Document metadata.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata", +"properties": { +"document": { +"description": "Document resource name.", +"type": "string" +}, +"domain": { +"description": "Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.", +"type": "string" +}, +"mimeType": { +"description": "The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.", +"type": "string" +}, +"pageIdentifier": { +"description": "Page identifier.", +"type": "string" +}, +"title": { +"description": "Title.", +"type": "string" +}, +"uri": { +"description": "URI for the document. It may contain a URL that redirects to the actual website.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment": { +"description": "Grounding information for a segment of the text.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment", +"properties": { +"endIndex": { +"description": "End of the segment, exclusive.", +"format": "int64", +"type": "string" +}, +"groundingScore": { +"description": "Score for the segment.", +"format": "float", +"type": "number" +}, +"referenceIndices": { +"description": "References for the segment.", +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, +"startIndex": { +"description": "Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one).", +"format": "int64", +"type": "string" +}, +"text": { +"description": "The text segment itself.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaBAPConfig": { +"description": "The configuration for the BAP connector.", +"id": "GoogleCloudDiscoveryengineV1alphaBAPConfig", +"properties": { +"enabledActions": { +"description": "Optional. The actions enabled on the associated BAP connection.", +"items": { +"type": "string" +}, +"type": "array" +}, +"supportedConnectorModes": { +"description": "Required. The supported connector modes for the associated BAP connection.", +"items": { +"enum": [ +"CONNECTOR_MODE_UNSPECIFIED", +"DATA_INGESTION", +"ACTIONS", +"END_USER_AUTHENTICATION" +], +"enumDescriptions": [ +"Connector mode unspecified.", +"Connector utilized for data ingestion.", +"Connector utilized for Actions", +"Connector utilized for End User Authentication." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", @@ -19077,6 +19777,17 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaContactDetails": { +"description": "The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.", +"id": "GoogleCloudDiscoveryengineV1alphaContactDetails", +"properties": { +"emailAddress": { +"description": "Optional. The email address of the contact.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaControl": { "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", "id": "GoogleCloudDiscoveryengineV1alphaControl", @@ -19928,7 +20639,7 @@ false "readOnly": true }, "configurableBillingApproach": { -"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", +"description": "Optional. Configuration for configurable billing approach. See", "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", @@ -20547,7 +21258,7 @@ false "description": "Common config spec that specifies the metadata of the engine." }, "configurableBillingApproach": { -"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.", +"description": "Optional. Configuration for configurable billing approach.", "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_BILLING_APPROACH_ENABLED" @@ -20593,7 +21304,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`", "type": "object" }, "industryVertical": { @@ -21653,6 +22364,107 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaLicenseConfig": { +"description": "Information about users' licenses.", +"id": "GoogleCloudDiscoveryengineV1alphaLicenseConfig", +"properties": { +"alertPolicyResourceConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig", +"description": "Optional. The alert policy config for this license config." +}, +"autoRenew": { +"description": "Optional. Whether the license config should be auto renewed when it reaches the end date.", +"type": "boolean" +}, +"endDate": { +"$ref": "GoogleTypeDate", +"description": "Optional. The planed end date." +}, +"freeTrial": { +"description": "Optional. Whether the license config is for free trial.", +"type": "boolean" +}, +"licenseCount": { +"description": "Required. Number of licenses purchased.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`", +"type": "string" +}, +"startDate": { +"$ref": "GoogleTypeDate", +"description": "Required. The start date." +}, +"state": { +"description": "Output only. The state of the license config.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"EXPIRED", +"NOT_STARTED" +], +"enumDescriptions": [ +"Default value. The license config does not exist.", +"The license config is effective and being used.", +"The license config has expired.", +"The license config has not started yet, and its start date is in the future." +], +"readOnly": true, +"type": "string" +}, +"subscriptionTerm": { +"description": "Required. Subscription term.", +"enum": [ +"SUBSCRIPTION_TERM_UNSPECIFIED", +"SUBSCRIPTION_TERM_ONE_MONTH", +"SUBSCRIPTION_TERM_ONE_YEAR", +"SUBSCRIPTION_TERM_THREE_YEARS" +], +"enumDescriptions": [ +"Default value, do not use.", +"1 month.", +"1 year.", +"3 years." +], +"type": "string" +}, +"subscriptionTier": { +"description": "Required. Subscription tier information for the license config.", +"enum": [ +"SUBSCRIPTION_TIER_UNSPECIFIED", +"SUBSCRIPTION_TIER_SEARCH", +"SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT", +"SUBSCRIPTION_TIER_NOTEBOOK_LM", +"SUBSCRIPTION_TIER_FRONTLINE_WORKER", +"SUBSCRIPTION_TIER_AGENTSPACE_STARTER", +"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS", +"SUBSCRIPTION_TIER_ENTERPRISE", +"SUBSCRIPTION_TIER_EDU", +"SUBSCRIPTION_TIER_EDU_PRO", +"SUBSCRIPTION_TIER_EDU_EMERGING", +"SUBSCRIPTION_TIER_EDU_PRO_EMERGING" +], +"enumDescriptions": [ +"Default value.", +"Search tier. Search tier can access VAIS search features and NotebookLM features.", +"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.", +"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.", +"Frontline worker tier.", +"Agentspace Starter tier.", +"Agentspace Business tier.", +"Enterprise tier.", +"EDU tier.", +"EDU Pro tier.", +"EDU emerging market tier.", +"EDU Pro emerging market tier." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaListSessionsRequest": { "description": "Request for ListSessions method.", "id": "GoogleCloudDiscoveryengineV1alphaListSessionsRequest", @@ -23366,6 +24178,11 @@ false "description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.", "readOnly": true }, +"detailedAssistAnswer": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswer", +"description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session.", +"readOnly": true +}, "query": { "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", "description": "Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn" @@ -23942,6 +24759,67 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig": { +"description": "The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.", +"id": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig", +"properties": { +"alertEnrollments": { +"description": "Optional. The enrollment state of each alert.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment" +}, +"type": "array" +}, +"alertPolicy": { +"description": "Immutable. The fully qualified resource name of the AlertPolicy.", +"type": "string" +}, +"contactDetails": { +"description": "Optional. The contact details for each alert policy.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaContactDetails" +}, +"type": "array" +}, +"languageCode": { +"description": "Optional. The language code used for notifications", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment": { +"description": "The alert enrollment status.", +"id": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment", +"properties": { +"alertId": { +"description": "Immutable. The id of an alert.", +"type": "string" +}, +"enrollState": { +"description": "Required. The enrollment status of a customer.", +"enum": [ +"ENROLL_STATE_UNSPECIFIED", +"ENROLLED", +"DECLINED" +], +"enumDescriptions": [ +"Default value. Used for customers who have not responded to the alert policy.", +"Customer is enrolled in this policy.", +"Customer declined this policy." +], +"type": "string" +}, +"notificationParams": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", @@ -24162,6 +25040,17 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaContactDetails": { +"description": "The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.", +"id": "GoogleCloudDiscoveryengineV1betaContactDetails", +"properties": { +"emailAddress": { +"description": "Optional. The email address of the contact.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaControl": { "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", "id": "GoogleCloudDiscoveryengineV1betaControl", @@ -24517,7 +25406,7 @@ false "readOnly": true }, "configurableBillingApproach": { -"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", +"description": "Optional. Configuration for configurable billing approach. See", "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", @@ -25040,7 +25929,7 @@ false "description": "Common config spec that specifies the metadata of the engine." }, "configurableBillingApproach": { -"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.", +"description": "Optional. Configuration for configurable billing approach.", "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_BILLING_APPROACH_ENABLED" @@ -25086,7 +25975,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`", "type": "object" }, "industryVertical": { @@ -25817,6 +26706,107 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaLicenseConfig": { +"description": "Information about users' licenses.", +"id": "GoogleCloudDiscoveryengineV1betaLicenseConfig", +"properties": { +"alertPolicyResourceConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig", +"description": "Optional. The alert policy config for this license config." +}, +"autoRenew": { +"description": "Optional. Whether the license config should be auto renewed when it reaches the end date.", +"type": "boolean" +}, +"endDate": { +"$ref": "GoogleTypeDate", +"description": "Optional. The planed end date." +}, +"freeTrial": { +"description": "Optional. Whether the license config is for free trial.", +"type": "boolean" +}, +"licenseCount": { +"description": "Required. Number of licenses purchased.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`", +"type": "string" +}, +"startDate": { +"$ref": "GoogleTypeDate", +"description": "Required. The start date." +}, +"state": { +"description": "Output only. The state of the license config.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"EXPIRED", +"NOT_STARTED" +], +"enumDescriptions": [ +"Default value. The license config does not exist.", +"The license config is effective and being used.", +"The license config has expired.", +"The license config has not started yet, and its start date is in the future." +], +"readOnly": true, +"type": "string" +}, +"subscriptionTerm": { +"description": "Required. Subscription term.", +"enum": [ +"SUBSCRIPTION_TERM_UNSPECIFIED", +"SUBSCRIPTION_TERM_ONE_MONTH", +"SUBSCRIPTION_TERM_ONE_YEAR", +"SUBSCRIPTION_TERM_THREE_YEARS" +], +"enumDescriptions": [ +"Default value, do not use.", +"1 month.", +"1 year.", +"3 years." +], +"type": "string" +}, +"subscriptionTier": { +"description": "Required. Subscription tier information for the license config.", +"enum": [ +"SUBSCRIPTION_TIER_UNSPECIFIED", +"SUBSCRIPTION_TIER_SEARCH", +"SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT", +"SUBSCRIPTION_TIER_NOTEBOOK_LM", +"SUBSCRIPTION_TIER_FRONTLINE_WORKER", +"SUBSCRIPTION_TIER_AGENTSPACE_STARTER", +"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS", +"SUBSCRIPTION_TIER_ENTERPRISE", +"SUBSCRIPTION_TIER_EDU", +"SUBSCRIPTION_TIER_EDU_PRO", +"SUBSCRIPTION_TIER_EDU_EMERGING", +"SUBSCRIPTION_TIER_EDU_PRO_EMERGING" +], +"enumDescriptions": [ +"Default value.", +"Search tier. Search tier can access VAIS search features and NotebookLM features.", +"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.", +"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.", +"Frontline worker tier.", +"Agentspace Starter tier.", +"Agentspace Business tier.", +"Enterprise tier.", +"EDU tier.", +"EDU Pro tier.", +"EDU emerging market tier.", +"EDU Pro emerging market tier." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig": { "description": "Configuration for Natural Language Query Understanding.", "id": "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index b285c2976c..4133abc6c0 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -8775,6 +8775,102 @@ } } }, +"licenseConfigs": { +"methods": { +"create": { +"description": "Creates a LicenseConfig", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/licenseConfigs", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.licenseConfigs.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"licenseConfigId": { +"description": "Optional. The ID to use for the LicenseConfig, which will become the final component of the LicenseConfig's resource name. We are using the tier (product edition) name as the license config id such as `search` or `search_and_assistant`.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/licenseConfigs", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfig" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a LicenseConfig.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/licenseConfigs/{licenseConfigsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.licenseConfigs.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of LicenseConfig, such as `projects/{project}/locations/{location}/licenseConfigs/*`. If the caller does not have permission to access the LicenseConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested LicenseConfig does not exist, a NOT_FOUND error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/licenseConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the LicenseConfig", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/licenseConfigs/{licenseConfigsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.licenseConfigs.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/licenseConfigs/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Indicates which fields in the provided LicenseConfig to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfig" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "notebooks": { "methods": { "batchDelete": { @@ -9988,7 +10084,7 @@ } } }, -"revision": "20250924", +"revision": "20250929", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "ApiservingMediaRequestInfo": { @@ -11106,6 +11202,67 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig": { +"description": "The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.", +"id": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig", +"properties": { +"alertEnrollments": { +"description": "Optional. The enrollment state of each alert.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment" +}, +"type": "array" +}, +"alertPolicy": { +"description": "Immutable. The fully qualified resource name of the AlertPolicy.", +"type": "string" +}, +"contactDetails": { +"description": "Optional. The contact details for each alert policy.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1ContactDetails" +}, +"type": "array" +}, +"languageCode": { +"description": "Optional. The language code used for notifications", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment": { +"description": "The alert enrollment status.", +"id": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment", +"properties": { +"alertId": { +"description": "Immutable. The id of an alert.", +"type": "string" +}, +"enrollState": { +"description": "Required. The enrollment status of a customer.", +"enum": [ +"ENROLL_STATE_UNSPECIFIED", +"ENROLLED", +"DECLINED" +], +"enumDescriptions": [ +"Default value. Used for customers who have not responded to the alert policy.", +"Customer is enrolled in this policy.", +"Customer declined this policy." +], +"type": "string" +}, +"notificationParams": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1AnswerGenerationSpec": { "description": "The specification for answer generation.", "id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec", @@ -11607,6 +11764,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1ContactDetails": { +"description": "The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.", +"id": "GoogleCloudDiscoveryengineV1ContactDetails", +"properties": { +"emailAddress": { +"description": "Optional. The email address of the contact.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1Control": { "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", "id": "GoogleCloudDiscoveryengineV1Control", @@ -12430,7 +12598,7 @@ "readOnly": true }, "configurableBillingApproach": { -"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", +"description": "Optional. Configuration for configurable billing approach. See", "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", @@ -13002,7 +13170,7 @@ "description": "Common config spec that specifies the metadata of the engine." }, "configurableBillingApproach": { -"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.", +"description": "Optional. Configuration for configurable billing approach.", "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_BILLING_APPROACH_ENABLED" @@ -13048,7 +13216,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`", "type": "object" }, "industryVertical": { @@ -13602,6 +13770,107 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1LicenseConfig": { +"description": "Information about users' licenses.", +"id": "GoogleCloudDiscoveryengineV1LicenseConfig", +"properties": { +"alertPolicyResourceConfig": { +"$ref": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig", +"description": "Optional. The alert policy config for this license config." +}, +"autoRenew": { +"description": "Optional. Whether the license config should be auto renewed when it reaches the end date.", +"type": "boolean" +}, +"endDate": { +"$ref": "GoogleTypeDate", +"description": "Optional. The planed end date." +}, +"freeTrial": { +"description": "Optional. Whether the license config is for free trial.", +"type": "boolean" +}, +"licenseCount": { +"description": "Required. Number of licenses purchased.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`", +"type": "string" +}, +"startDate": { +"$ref": "GoogleTypeDate", +"description": "Required. The start date." +}, +"state": { +"description": "Output only. The state of the license config.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"EXPIRED", +"NOT_STARTED" +], +"enumDescriptions": [ +"Default value. The license config does not exist.", +"The license config is effective and being used.", +"The license config has expired.", +"The license config has not started yet, and its start date is in the future." +], +"readOnly": true, +"type": "string" +}, +"subscriptionTerm": { +"description": "Required. Subscription term.", +"enum": [ +"SUBSCRIPTION_TERM_UNSPECIFIED", +"SUBSCRIPTION_TERM_ONE_MONTH", +"SUBSCRIPTION_TERM_ONE_YEAR", +"SUBSCRIPTION_TERM_THREE_YEARS" +], +"enumDescriptions": [ +"Default value, do not use.", +"1 month.", +"1 year.", +"3 years." +], +"type": "string" +}, +"subscriptionTier": { +"description": "Required. Subscription tier information for the license config.", +"enum": [ +"SUBSCRIPTION_TIER_UNSPECIFIED", +"SUBSCRIPTION_TIER_SEARCH", +"SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT", +"SUBSCRIPTION_TIER_NOTEBOOK_LM", +"SUBSCRIPTION_TIER_FRONTLINE_WORKER", +"SUBSCRIPTION_TIER_AGENTSPACE_STARTER", +"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS", +"SUBSCRIPTION_TIER_ENTERPRISE", +"SUBSCRIPTION_TIER_EDU", +"SUBSCRIPTION_TIER_EDU_PRO", +"SUBSCRIPTION_TIER_EDU_EMERGING", +"SUBSCRIPTION_TIER_EDU_PRO_EMERGING" +], +"enumDescriptions": [ +"Default value.", +"Search tier. Search tier can access VAIS search features and NotebookLM features.", +"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.", +"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.", +"Frontline worker tier.", +"Agentspace Starter tier.", +"Agentspace Business tier.", +"Enterprise tier.", +"EDU tier.", +"EDU Pro tier.", +"EDU emerging market tier.", +"EDU Pro emerging market tier." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1Project": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1Project", @@ -15084,6 +15353,67 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig": { +"description": "The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.", +"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig", +"properties": { +"alertEnrollments": { +"description": "Optional. The enrollment state of each alert.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment" +}, +"type": "array" +}, +"alertPolicy": { +"description": "Immutable. The fully qualified resource name of the AlertPolicy.", +"type": "string" +}, +"contactDetails": { +"description": "Optional. The contact details for each alert policy.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaContactDetails" +}, +"type": "array" +}, +"languageCode": { +"description": "Optional. The language code used for notifications", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment": { +"description": "The alert enrollment status.", +"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment", +"properties": { +"alertId": { +"description": "Immutable. The id of an alert.", +"type": "string" +}, +"enrollState": { +"description": "Required. The enrollment status of a customer.", +"enum": [ +"ENROLL_STATE_UNSPECIFIED", +"ENROLLED", +"DECLINED" +], +"enumDescriptions": [ +"Default value. Used for customers who have not responded to the alert policy.", +"Customer is enrolled in this policy.", +"Customer declined this policy." +], +"type": "string" +}, +"notificationParams": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAlloyDbSource": { "description": "AlloyDB source import data from.", "id": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", @@ -18347,6 +18677,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaContactDetails": { +"description": "The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.", +"id": "GoogleCloudDiscoveryengineV1alphaContactDetails", +"properties": { +"emailAddress": { +"description": "Optional. The email address of the contact.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaControl": { "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", "id": "GoogleCloudDiscoveryengineV1alphaControl", @@ -19460,7 +19801,7 @@ "readOnly": true }, "configurableBillingApproach": { -"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", +"description": "Optional. Configuration for configurable billing approach. See", "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", @@ -20296,7 +20637,7 @@ "description": "Common config spec that specifies the metadata of the engine." }, "configurableBillingApproach": { -"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.", +"description": "Optional. Configuration for configurable billing approach.", "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_BILLING_APPROACH_ENABLED" @@ -20342,7 +20683,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`", "type": "object" }, "industryVertical": { @@ -22209,6 +22550,107 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaLicenseConfig": { +"description": "Information about users' licenses.", +"id": "GoogleCloudDiscoveryengineV1alphaLicenseConfig", +"properties": { +"alertPolicyResourceConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig", +"description": "Optional. The alert policy config for this license config." +}, +"autoRenew": { +"description": "Optional. Whether the license config should be auto renewed when it reaches the end date.", +"type": "boolean" +}, +"endDate": { +"$ref": "GoogleTypeDate", +"description": "Optional. The planed end date." +}, +"freeTrial": { +"description": "Optional. Whether the license config is for free trial.", +"type": "boolean" +}, +"licenseCount": { +"description": "Required. Number of licenses purchased.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`", +"type": "string" +}, +"startDate": { +"$ref": "GoogleTypeDate", +"description": "Required. The start date." +}, +"state": { +"description": "Output only. The state of the license config.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"EXPIRED", +"NOT_STARTED" +], +"enumDescriptions": [ +"Default value. The license config does not exist.", +"The license config is effective and being used.", +"The license config has expired.", +"The license config has not started yet, and its start date is in the future." +], +"readOnly": true, +"type": "string" +}, +"subscriptionTerm": { +"description": "Required. Subscription term.", +"enum": [ +"SUBSCRIPTION_TERM_UNSPECIFIED", +"SUBSCRIPTION_TERM_ONE_MONTH", +"SUBSCRIPTION_TERM_ONE_YEAR", +"SUBSCRIPTION_TERM_THREE_YEARS" +], +"enumDescriptions": [ +"Default value, do not use.", +"1 month.", +"1 year.", +"3 years." +], +"type": "string" +}, +"subscriptionTier": { +"description": "Required. Subscription tier information for the license config.", +"enum": [ +"SUBSCRIPTION_TIER_UNSPECIFIED", +"SUBSCRIPTION_TIER_SEARCH", +"SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT", +"SUBSCRIPTION_TIER_NOTEBOOK_LM", +"SUBSCRIPTION_TIER_FRONTLINE_WORKER", +"SUBSCRIPTION_TIER_AGENTSPACE_STARTER", +"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS", +"SUBSCRIPTION_TIER_ENTERPRISE", +"SUBSCRIPTION_TIER_EDU", +"SUBSCRIPTION_TIER_EDU_PRO", +"SUBSCRIPTION_TIER_EDU_EMERGING", +"SUBSCRIPTION_TIER_EDU_PRO_EMERGING" +], +"enumDescriptions": [ +"Default value.", +"Search tier. Search tier can access VAIS search features and NotebookLM features.", +"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.", +"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.", +"Frontline worker tier.", +"Agentspace Starter tier.", +"Agentspace Business tier.", +"Enterprise tier.", +"EDU tier.", +"EDU Pro tier.", +"EDU emerging market tier.", +"EDU Pro emerging market tier." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaListBranchesResponse": { "description": "Response for BranchService.ListBranches method.", "id": "GoogleCloudDiscoveryengineV1alphaListBranchesResponse", @@ -26153,6 +26595,11 @@ false "description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.", "readOnly": true }, +"detailedAssistAnswer": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswer", +"description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session.", +"readOnly": true +}, "query": { "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", "description": "Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn" @@ -27929,7 +28376,7 @@ false ], "type": "string" }, -"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", +"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`", "readOnly": true, "type": "object" }, @@ -28106,6 +28553,67 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig": { +"description": "The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.", +"id": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig", +"properties": { +"alertEnrollments": { +"description": "Optional. The enrollment state of each alert.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment" +}, +"type": "array" +}, +"alertPolicy": { +"description": "Immutable. The fully qualified resource name of the AlertPolicy.", +"type": "string" +}, +"contactDetails": { +"description": "Optional. The contact details for each alert policy.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaContactDetails" +}, +"type": "array" +}, +"languageCode": { +"description": "Optional. The language code used for notifications", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment": { +"description": "The alert enrollment status.", +"id": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment", +"properties": { +"alertId": { +"description": "Immutable. The id of an alert.", +"type": "string" +}, +"enrollState": { +"description": "Required. The enrollment status of a customer.", +"enum": [ +"ENROLL_STATE_UNSPECIFIED", +"ENROLLED", +"DECLINED" +], +"enumDescriptions": [ +"Default value. Used for customers who have not responded to the alert policy.", +"Customer is enrolled in this policy.", +"Customer declined this policy." +], +"type": "string" +}, +"notificationParams": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", @@ -28326,6 +28834,17 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaContactDetails": { +"description": "The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.", +"id": "GoogleCloudDiscoveryengineV1betaContactDetails", +"properties": { +"emailAddress": { +"description": "Optional. The email address of the contact.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaControl": { "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", "id": "GoogleCloudDiscoveryengineV1betaControl", @@ -28681,7 +29200,7 @@ false "readOnly": true }, "configurableBillingApproach": { -"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", +"description": "Optional. Configuration for configurable billing approach. See", "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", @@ -29204,7 +29723,7 @@ false "description": "Common config spec that specifies the metadata of the engine." }, "configurableBillingApproach": { -"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.", +"description": "Optional. Configuration for configurable billing approach.", "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_BILLING_APPROACH_ENABLED" @@ -29250,7 +29769,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`", "type": "object" }, "industryVertical": { @@ -29981,6 +30500,107 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaLicenseConfig": { +"description": "Information about users' licenses.", +"id": "GoogleCloudDiscoveryengineV1betaLicenseConfig", +"properties": { +"alertPolicyResourceConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig", +"description": "Optional. The alert policy config for this license config." +}, +"autoRenew": { +"description": "Optional. Whether the license config should be auto renewed when it reaches the end date.", +"type": "boolean" +}, +"endDate": { +"$ref": "GoogleTypeDate", +"description": "Optional. The planed end date." +}, +"freeTrial": { +"description": "Optional. Whether the license config is for free trial.", +"type": "boolean" +}, +"licenseCount": { +"description": "Required. Number of licenses purchased.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`", +"type": "string" +}, +"startDate": { +"$ref": "GoogleTypeDate", +"description": "Required. The start date." +}, +"state": { +"description": "Output only. The state of the license config.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"EXPIRED", +"NOT_STARTED" +], +"enumDescriptions": [ +"Default value. The license config does not exist.", +"The license config is effective and being used.", +"The license config has expired.", +"The license config has not started yet, and its start date is in the future." +], +"readOnly": true, +"type": "string" +}, +"subscriptionTerm": { +"description": "Required. Subscription term.", +"enum": [ +"SUBSCRIPTION_TERM_UNSPECIFIED", +"SUBSCRIPTION_TERM_ONE_MONTH", +"SUBSCRIPTION_TERM_ONE_YEAR", +"SUBSCRIPTION_TERM_THREE_YEARS" +], +"enumDescriptions": [ +"Default value, do not use.", +"1 month.", +"1 year.", +"3 years." +], +"type": "string" +}, +"subscriptionTier": { +"description": "Required. Subscription tier information for the license config.", +"enum": [ +"SUBSCRIPTION_TIER_UNSPECIFIED", +"SUBSCRIPTION_TIER_SEARCH", +"SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT", +"SUBSCRIPTION_TIER_NOTEBOOK_LM", +"SUBSCRIPTION_TIER_FRONTLINE_WORKER", +"SUBSCRIPTION_TIER_AGENTSPACE_STARTER", +"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS", +"SUBSCRIPTION_TIER_ENTERPRISE", +"SUBSCRIPTION_TIER_EDU", +"SUBSCRIPTION_TIER_EDU_PRO", +"SUBSCRIPTION_TIER_EDU_EMERGING", +"SUBSCRIPTION_TIER_EDU_PRO_EMERGING" +], +"enumDescriptions": [ +"Default value.", +"Search tier. Search tier can access VAIS search features and NotebookLM features.", +"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.", +"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.", +"Frontline worker tier.", +"Agentspace Starter tier.", +"Agentspace Business tier.", +"Enterprise tier.", +"EDU tier.", +"EDU Pro tier.", +"EDU emerging market tier.", +"EDU Pro emerging market tier." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig": { "description": "Configuration for Natural Language Query Understanding.", "id": "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index b7227ff14d..b727e38cb7 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -7497,6 +7497,102 @@ } } }, +"licenseConfigs": { +"methods": { +"create": { +"description": "Creates a LicenseConfig", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/licenseConfigs", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.licenseConfigs.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"licenseConfigId": { +"description": "Optional. The ID to use for the LicenseConfig, which will become the final component of the LicenseConfig's resource name. We are using the tier (product edition) name as the license config id such as `search` or `search_and_assistant`.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/licenseConfigs", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaLicenseConfig" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaLicenseConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a LicenseConfig.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/licenseConfigs/{licenseConfigsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.licenseConfigs.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of LicenseConfig, such as `projects/{project}/locations/{location}/licenseConfigs/*`. If the caller does not have permission to access the LicenseConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested LicenseConfig does not exist, a NOT_FOUND error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/licenseConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaLicenseConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the LicenseConfig", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/licenseConfigs/{licenseConfigsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.licenseConfigs.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/licenseConfigs/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Indicates which fields in the provided LicenseConfig to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaLicenseConfig" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaLicenseConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "operations": { "methods": { "get": { @@ -8275,7 +8371,7 @@ } } }, -"revision": "20250924", +"revision": "20250929", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -9226,6 +9322,67 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig": { +"description": "The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.", +"id": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig", +"properties": { +"alertEnrollments": { +"description": "Optional. The enrollment state of each alert.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment" +}, +"type": "array" +}, +"alertPolicy": { +"description": "Immutable. The fully qualified resource name of the AlertPolicy.", +"type": "string" +}, +"contactDetails": { +"description": "Optional. The contact details for each alert policy.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1ContactDetails" +}, +"type": "array" +}, +"languageCode": { +"description": "Optional. The language code used for notifications", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment": { +"description": "The alert enrollment status.", +"id": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment", +"properties": { +"alertId": { +"description": "Immutable. The id of an alert.", +"type": "string" +}, +"enrollState": { +"description": "Required. The enrollment status of a customer.", +"enum": [ +"ENROLL_STATE_UNSPECIFIED", +"ENROLLED", +"DECLINED" +], +"enumDescriptions": [ +"Default value. Used for customers who have not responded to the alert policy.", +"Customer is enrolled in this policy.", +"Customer declined this policy." +], +"type": "string" +}, +"notificationParams": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1AnswerGenerationSpec": { "description": "The specification for answer generation.", "id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec", @@ -9727,6 +9884,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1ContactDetails": { +"description": "The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.", +"id": "GoogleCloudDiscoveryengineV1ContactDetails", +"properties": { +"emailAddress": { +"description": "Optional. The email address of the contact.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1Control": { "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", "id": "GoogleCloudDiscoveryengineV1Control", @@ -10550,7 +10718,7 @@ "readOnly": true }, "configurableBillingApproach": { -"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", +"description": "Optional. Configuration for configurable billing approach. See", "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", @@ -11122,7 +11290,7 @@ "description": "Common config spec that specifies the metadata of the engine." }, "configurableBillingApproach": { -"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.", +"description": "Optional. Configuration for configurable billing approach.", "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_BILLING_APPROACH_ENABLED" @@ -11168,7 +11336,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`", "type": "object" }, "industryVertical": { @@ -11722,6 +11890,107 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1LicenseConfig": { +"description": "Information about users' licenses.", +"id": "GoogleCloudDiscoveryengineV1LicenseConfig", +"properties": { +"alertPolicyResourceConfig": { +"$ref": "GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig", +"description": "Optional. The alert policy config for this license config." +}, +"autoRenew": { +"description": "Optional. Whether the license config should be auto renewed when it reaches the end date.", +"type": "boolean" +}, +"endDate": { +"$ref": "GoogleTypeDate", +"description": "Optional. The planed end date." +}, +"freeTrial": { +"description": "Optional. Whether the license config is for free trial.", +"type": "boolean" +}, +"licenseCount": { +"description": "Required. Number of licenses purchased.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`", +"type": "string" +}, +"startDate": { +"$ref": "GoogleTypeDate", +"description": "Required. The start date." +}, +"state": { +"description": "Output only. The state of the license config.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"EXPIRED", +"NOT_STARTED" +], +"enumDescriptions": [ +"Default value. The license config does not exist.", +"The license config is effective and being used.", +"The license config has expired.", +"The license config has not started yet, and its start date is in the future." +], +"readOnly": true, +"type": "string" +}, +"subscriptionTerm": { +"description": "Required. Subscription term.", +"enum": [ +"SUBSCRIPTION_TERM_UNSPECIFIED", +"SUBSCRIPTION_TERM_ONE_MONTH", +"SUBSCRIPTION_TERM_ONE_YEAR", +"SUBSCRIPTION_TERM_THREE_YEARS" +], +"enumDescriptions": [ +"Default value, do not use.", +"1 month.", +"1 year.", +"3 years." +], +"type": "string" +}, +"subscriptionTier": { +"description": "Required. Subscription tier information for the license config.", +"enum": [ +"SUBSCRIPTION_TIER_UNSPECIFIED", +"SUBSCRIPTION_TIER_SEARCH", +"SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT", +"SUBSCRIPTION_TIER_NOTEBOOK_LM", +"SUBSCRIPTION_TIER_FRONTLINE_WORKER", +"SUBSCRIPTION_TIER_AGENTSPACE_STARTER", +"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS", +"SUBSCRIPTION_TIER_ENTERPRISE", +"SUBSCRIPTION_TIER_EDU", +"SUBSCRIPTION_TIER_EDU_PRO", +"SUBSCRIPTION_TIER_EDU_EMERGING", +"SUBSCRIPTION_TIER_EDU_PRO_EMERGING" +], +"enumDescriptions": [ +"Default value.", +"Search tier. Search tier can access VAIS search features and NotebookLM features.", +"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.", +"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.", +"Frontline worker tier.", +"Agentspace Starter tier.", +"Agentspace Business tier.", +"Enterprise tier.", +"EDU tier.", +"EDU Pro tier.", +"EDU emerging market tier.", +"EDU Pro emerging market tier." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1Project": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1Project", @@ -12871,6 +13140,67 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig": { +"description": "The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.", +"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig", +"properties": { +"alertEnrollments": { +"description": "Optional. The enrollment state of each alert.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment" +}, +"type": "array" +}, +"alertPolicy": { +"description": "Immutable. The fully qualified resource name of the AlertPolicy.", +"type": "string" +}, +"contactDetails": { +"description": "Optional. The contact details for each alert policy.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaContactDetails" +}, +"type": "array" +}, +"languageCode": { +"description": "Optional. The language code used for notifications", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment": { +"description": "The alert enrollment status.", +"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment", +"properties": { +"alertId": { +"description": "Immutable. The id of an alert.", +"type": "string" +}, +"enrollState": { +"description": "Required. The enrollment status of a customer.", +"enum": [ +"ENROLL_STATE_UNSPECIFIED", +"ENROLLED", +"DECLINED" +], +"enumDescriptions": [ +"Default value. Used for customers who have not responded to the alert policy.", +"Customer is enrolled in this policy.", +"Customer declined this policy." +], +"type": "string" +}, +"notificationParams": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAnswer": { "description": "Defines an answer.", "id": "GoogleCloudDiscoveryengineV1alphaAnswer", @@ -13388,108 +13718,473 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", "description": "Observation." }, -"searchAction": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", -"description": "Search action." +"searchAction": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", +"description": "Search action." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { +"description": "Observation.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", +"properties": { +"searchResults": { +"description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", +"properties": { +"chunkInfo": { +"description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo" +}, +"type": "array" +}, +"document": { +"description": "Document resource name.", +"type": "string" +}, +"snippetInfo": { +"description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo" +}, +"type": "array" +}, +"structData": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.", +"type": "object" +}, +"title": { +"description": "Title.", +"type": "string" +}, +"uri": { +"description": "URI for the document.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { +"description": "Chunk information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo", +"properties": { +"chunk": { +"description": "Chunk resource name.", +"type": "string" +}, +"content": { +"description": "Chunk textual content.", +"type": "string" +}, +"relevanceScore": { +"description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { +"description": "Snippet information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", +"properties": { +"snippet": { +"description": "Snippet content.", +"type": "string" +}, +"snippetStatus": { +"description": "Status of the snippet defined by the search team.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { +"description": "Search action.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", +"properties": { +"query": { +"description": "The query to search.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistAnswer": { +"description": "AssistAnswer resource, main part of AssistResponse.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistAnswer", +"properties": { +"assistSkippedReasons": { +"description": "Reasons for not answering the assist call.", +"items": { +"enum": [ +"ASSIST_SKIPPED_REASON_UNSPECIFIED", +"NON_ASSIST_SEEKING_QUERY_IGNORED", +"CUSTOMER_POLICY_VIOLATION" +], +"enumDescriptions": [ +"Default value. Skip reason is not specified.", +"The assistant ignored the query, because it did not appear to be answer-seeking.", +"The assistant ignored the query or refused to answer because of a customer policy violation (e.g., the query or the answer contained a banned phrase)." +], +"type": "string" +}, +"type": "array" +}, +"customerPolicyEnforcementResult": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult", +"description": "Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation." +}, +"name": { +"description": "Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"replies": { +"description": "Replies of the assistant.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerReply" +}, +"type": "array" +}, +"state": { +"description": "State of the answer generation.", +"enum": [ +"STATE_UNSPECIFIED", +"IN_PROGRESS", +"FAILED", +"SUCCEEDED", +"SKIPPED" +], +"enumDescriptions": [ +"Unknown.", +"Assist operation is currently in progress.", +"Assist operation has failed.", +"Assist operation has succeeded.", +"Assist operation has been skipped." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult": { +"description": "Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult", +"properties": { +"policyResults": { +"description": "Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult" +}, +"type": "array" +}, +"verdict": { +"description": "Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK.", +"enum": [ +"UNSPECIFIED", +"ALLOW", +"BLOCK" +], +"enumDescriptions": [ +"Unknown value.", +"There was no policy violation.", +"Processing was blocked by the customer policy." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult": { +"description": "Customer policy enforcement result for the banned phrase policy.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult", +"properties": { +"bannedPhrases": { +"description": "The banned phrases that were found in the query or the answer.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult": { +"description": "Customer policy enforcement result for the Model Armor policy.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult", +"properties": { +"error": { +"$ref": "GoogleRpcStatus", +"description": "The error returned by Model Armor if the policy enforcement failed for some reason." +}, +"modelArmorViolation": { +"description": "The Model Armor violation that was found.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult": { +"description": "Customer policy enforcement result for a single policy type.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult", +"properties": { +"bannedPhraseEnforcementResult": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult", +"description": "The policy enforcement result for the banned phrase policy." +}, +"modelArmorEnforcementResult": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult", +"description": "The policy enforcement result for the Model Armor policy." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistAnswerReply": { +"description": "One part of the multi-part response of the assist call.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerReply", +"properties": { +"groundedContent": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent", +"description": "Possibly grounded response text or media from the assistant." +}, +"replyId": { +"description": "Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantContent": { +"description": "Multi-modal content.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantContent", +"properties": { +"codeExecutionResult": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult", +"description": "Result of executing an ExecutableCode." +}, +"executableCode": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode", +"description": "Code generated by the model that is meant to be executed." +}, +"file": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContentFile", +"description": "A file, e.g., an audio summary." +}, +"inlineData": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContentBlob", +"description": "Inline binary data." +}, +"role": { +"description": "The producer of the content. Can be \"model\" or \"user\".", +"type": "string" +}, +"text": { +"description": "Inline text.", +"type": "string" +}, +"thought": { +"description": "Optional. Indicates if the part is thought from the model.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantContentBlob": { +"description": "Inline blob.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantContentBlob", +"properties": { +"data": { +"description": "Required. Raw bytes.", +"format": "byte", +"type": "string" +}, +"mimeType": { +"description": "Required. The media type (MIME type) of the generated data.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult": { +"description": "Result of executing ExecutableCode.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult", +"properties": { +"outcome": { +"description": "Required. Outcome of the code execution.", +"enum": [ +"OUTCOME_UNSPECIFIED", +"OUTCOME_OK", +"OUTCOME_FAILED", +"OUTCOME_DEADLINE_EXCEEDED" +], +"enumDescriptions": [ +"Unspecified status. This value should not be used.", +"Code execution completed successfully.", +"Code execution finished but with a failure. `stderr` should contain the reason.", +"Code execution ran for too long, and was cancelled. There may or may not be a partial output present." +], +"type": "string" +}, +"output": { +"description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode": { +"description": "Code generated by the model that is meant to be executed by the model.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode", +"properties": { +"code": { +"description": "Required. The code content. Currently only supports Python.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantContentFile": { +"description": "A file, e.g., an audio summary.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantContentFile", +"properties": { +"fileId": { +"description": "Required. The file ID.", +"type": "string" +}, +"mimeType": { +"description": "Required. The media type (MIME type) of the file.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent": { +"description": "A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like \"Of course, I will gladly search it for you.\" do not need grounding.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent", +"properties": { +"content": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContent", +"description": "The content." +}, +"textGroundingMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata", +"description": "Metadata for grounding based on text sources." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { -"description": "Observation.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", +"GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata": { +"description": "Grounding details for text sources.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata", "properties": { -"searchResults": { -"description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.", +"references": { +"description": "References for the grounded text.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult" +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference" +}, +"type": "array" +}, +"segments": { +"description": "Grounding information for parts of the text.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", +"GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference": { +"description": "Referenced content and related document metadata.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference", "properties": { -"chunkInfo": { -"description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo" +"content": { +"description": "Referenced text content.", +"type": "string" }, -"type": "array" +"documentMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata", +"description": "Document metadata." +} +}, +"type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata": { +"description": "Document metadata.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata", +"properties": { "document": { "description": "Document resource name.", "type": "string" }, -"snippetInfo": { -"description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo" -}, -"type": "array" +"domain": { +"description": "Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.", +"type": "string" }, -"structData": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"mimeType": { +"description": "The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.", +"type": "string" }, -"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.", -"type": "object" +"pageIdentifier": { +"description": "Page identifier.", +"type": "string" }, "title": { "description": "Title.", "type": "string" }, "uri": { -"description": "URI for the document.", +"description": "URI for the document. It may contain a URL that redirects to the actual website.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { -"description": "Chunk information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo", +"GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment": { +"description": "Grounding information for a segment of the text.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment", "properties": { -"chunk": { -"description": "Chunk resource name.", -"type": "string" -}, -"content": { -"description": "Chunk textual content.", +"endIndex": { +"description": "End of the segment, exclusive.", +"format": "int64", "type": "string" }, -"relevanceScore": { -"description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", +"groundingScore": { +"description": "Score for the segment.", "format": "float", "type": "number" -} }, -"type": "object" +"referenceIndices": { +"description": "References for the segment.", +"items": { +"format": "int32", +"type": "integer" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { -"description": "Snippet information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", -"properties": { -"snippet": { -"description": "Snippet content.", -"type": "string" +"type": "array" }, -"snippetStatus": { -"description": "Status of the snippet defined by the search team.", +"startIndex": { +"description": "Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one).", +"format": "int64", "type": "string" -} -}, -"type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { -"description": "Search action.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", -"properties": { -"query": { -"description": "The query to search.", +"text": { +"description": "The text segment itself.", "type": "string" } }, @@ -13998,6 +14693,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaContactDetails": { +"description": "The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.", +"id": "GoogleCloudDiscoveryengineV1alphaContactDetails", +"properties": { +"emailAddress": { +"description": "Optional. The email address of the contact.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaControl": { "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", "id": "GoogleCloudDiscoveryengineV1alphaControl", @@ -14849,7 +15555,7 @@ "readOnly": true }, "configurableBillingApproach": { -"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", +"description": "Optional. Configuration for configurable billing approach. See", "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", @@ -15468,7 +16174,7 @@ "description": "Common config spec that specifies the metadata of the engine." }, "configurableBillingApproach": { -"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.", +"description": "Optional. Configuration for configurable billing approach.", "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_BILLING_APPROACH_ENABLED" @@ -15514,7 +16220,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`", "type": "object" }, "industryVertical": { @@ -16574,6 +17280,107 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaLicenseConfig": { +"description": "Information about users' licenses.", +"id": "GoogleCloudDiscoveryengineV1alphaLicenseConfig", +"properties": { +"alertPolicyResourceConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig", +"description": "Optional. The alert policy config for this license config." +}, +"autoRenew": { +"description": "Optional. Whether the license config should be auto renewed when it reaches the end date.", +"type": "boolean" +}, +"endDate": { +"$ref": "GoogleTypeDate", +"description": "Optional. The planed end date." +}, +"freeTrial": { +"description": "Optional. Whether the license config is for free trial.", +"type": "boolean" +}, +"licenseCount": { +"description": "Required. Number of licenses purchased.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`", +"type": "string" +}, +"startDate": { +"$ref": "GoogleTypeDate", +"description": "Required. The start date." +}, +"state": { +"description": "Output only. The state of the license config.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"EXPIRED", +"NOT_STARTED" +], +"enumDescriptions": [ +"Default value. The license config does not exist.", +"The license config is effective and being used.", +"The license config has expired.", +"The license config has not started yet, and its start date is in the future." +], +"readOnly": true, +"type": "string" +}, +"subscriptionTerm": { +"description": "Required. Subscription term.", +"enum": [ +"SUBSCRIPTION_TERM_UNSPECIFIED", +"SUBSCRIPTION_TERM_ONE_MONTH", +"SUBSCRIPTION_TERM_ONE_YEAR", +"SUBSCRIPTION_TERM_THREE_YEARS" +], +"enumDescriptions": [ +"Default value, do not use.", +"1 month.", +"1 year.", +"3 years." +], +"type": "string" +}, +"subscriptionTier": { +"description": "Required. Subscription tier information for the license config.", +"enum": [ +"SUBSCRIPTION_TIER_UNSPECIFIED", +"SUBSCRIPTION_TIER_SEARCH", +"SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT", +"SUBSCRIPTION_TIER_NOTEBOOK_LM", +"SUBSCRIPTION_TIER_FRONTLINE_WORKER", +"SUBSCRIPTION_TIER_AGENTSPACE_STARTER", +"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS", +"SUBSCRIPTION_TIER_ENTERPRISE", +"SUBSCRIPTION_TIER_EDU", +"SUBSCRIPTION_TIER_EDU_PRO", +"SUBSCRIPTION_TIER_EDU_EMERGING", +"SUBSCRIPTION_TIER_EDU_PRO_EMERGING" +], +"enumDescriptions": [ +"Default value.", +"Search tier. Search tier can access VAIS search features and NotebookLM features.", +"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.", +"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.", +"Frontline worker tier.", +"Agentspace Starter tier.", +"Agentspace Business tier.", +"Enterprise tier.", +"EDU tier.", +"EDU Pro tier.", +"EDU emerging market tier.", +"EDU Pro emerging market tier." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaListSessionsRequest": { "description": "Request for ListSessions method.", "id": "GoogleCloudDiscoveryengineV1alphaListSessionsRequest", @@ -18287,6 +19094,11 @@ false "description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.", "readOnly": true }, +"detailedAssistAnswer": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswer", +"description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session.", +"readOnly": true +}, "query": { "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", "description": "Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn" @@ -19175,6 +19987,67 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig": { +"description": "The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.", +"id": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig", +"properties": { +"alertEnrollments": { +"description": "Optional. The enrollment state of each alert.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment" +}, +"type": "array" +}, +"alertPolicy": { +"description": "Immutable. The fully qualified resource name of the AlertPolicy.", +"type": "string" +}, +"contactDetails": { +"description": "Optional. The contact details for each alert policy.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaContactDetails" +}, +"type": "array" +}, +"languageCode": { +"description": "Optional. The language code used for notifications", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment": { +"description": "The alert enrollment status.", +"id": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment", +"properties": { +"alertId": { +"description": "Immutable. The id of an alert.", +"type": "string" +}, +"enrollState": { +"description": "Required. The enrollment status of a customer.", +"enum": [ +"ENROLL_STATE_UNSPECIFIED", +"ENROLLED", +"DECLINED" +], +"enumDescriptions": [ +"Default value. Used for customers who have not responded to the alert policy.", +"Customer is enrolled in this policy.", +"Customer declined this policy." +], +"type": "string" +}, +"notificationParams": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaAlloyDbSource": { "description": "AlloyDB source import data from.", "id": "GoogleCloudDiscoveryengineV1betaAlloyDbSource", @@ -22007,6 +22880,17 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaContactDetails": { +"description": "The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.", +"id": "GoogleCloudDiscoveryengineV1betaContactDetails", +"properties": { +"emailAddress": { +"description": "Optional. The email address of the contact.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaControl": { "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", "id": "GoogleCloudDiscoveryengineV1betaControl", @@ -22624,7 +23508,7 @@ false "readOnly": true }, "configurableBillingApproach": { -"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", +"description": "Optional. Configuration for configurable billing approach. See", "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", @@ -23364,7 +24248,7 @@ false "description": "Common config spec that specifies the metadata of the engine." }, "configurableBillingApproach": { -"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.", +"description": "Optional. Configuration for configurable billing approach.", "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_BILLING_APPROACH_ENABLED" @@ -23410,7 +24294,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`", "type": "object" }, "industryVertical": { @@ -24609,6 +25493,107 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaLicenseConfig": { +"description": "Information about users' licenses.", +"id": "GoogleCloudDiscoveryengineV1betaLicenseConfig", +"properties": { +"alertPolicyResourceConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig", +"description": "Optional. The alert policy config for this license config." +}, +"autoRenew": { +"description": "Optional. Whether the license config should be auto renewed when it reaches the end date.", +"type": "boolean" +}, +"endDate": { +"$ref": "GoogleTypeDate", +"description": "Optional. The planed end date." +}, +"freeTrial": { +"description": "Optional. Whether the license config is for free trial.", +"type": "boolean" +}, +"licenseCount": { +"description": "Required. Number of licenses purchased.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`", +"type": "string" +}, +"startDate": { +"$ref": "GoogleTypeDate", +"description": "Required. The start date." +}, +"state": { +"description": "Output only. The state of the license config.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"EXPIRED", +"NOT_STARTED" +], +"enumDescriptions": [ +"Default value. The license config does not exist.", +"The license config is effective and being used.", +"The license config has expired.", +"The license config has not started yet, and its start date is in the future." +], +"readOnly": true, +"type": "string" +}, +"subscriptionTerm": { +"description": "Required. Subscription term.", +"enum": [ +"SUBSCRIPTION_TERM_UNSPECIFIED", +"SUBSCRIPTION_TERM_ONE_MONTH", +"SUBSCRIPTION_TERM_ONE_YEAR", +"SUBSCRIPTION_TERM_THREE_YEARS" +], +"enumDescriptions": [ +"Default value, do not use.", +"1 month.", +"1 year.", +"3 years." +], +"type": "string" +}, +"subscriptionTier": { +"description": "Required. Subscription tier information for the license config.", +"enum": [ +"SUBSCRIPTION_TIER_UNSPECIFIED", +"SUBSCRIPTION_TIER_SEARCH", +"SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT", +"SUBSCRIPTION_TIER_NOTEBOOK_LM", +"SUBSCRIPTION_TIER_FRONTLINE_WORKER", +"SUBSCRIPTION_TIER_AGENTSPACE_STARTER", +"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS", +"SUBSCRIPTION_TIER_ENTERPRISE", +"SUBSCRIPTION_TIER_EDU", +"SUBSCRIPTION_TIER_EDU_PRO", +"SUBSCRIPTION_TIER_EDU_EMERGING", +"SUBSCRIPTION_TIER_EDU_PRO_EMERGING" +], +"enumDescriptions": [ +"Default value.", +"Search tier. Search tier can access VAIS search features and NotebookLM features.", +"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.", +"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.", +"Frontline worker tier.", +"Agentspace Starter tier.", +"Agentspace Business tier.", +"Enterprise tier.", +"EDU tier.", +"EDU Pro tier.", +"EDU emerging market tier.", +"EDU Pro emerging market tier." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse": { "description": "Response message for CmekConfigService.ListCmekConfigs method.", "id": "GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse", @@ -27998,6 +28983,11 @@ false "description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.", "readOnly": true }, +"detailedAssistAnswer": { +"$ref": "GoogleCloudDiscoveryengineV1betaAssistAnswer", +"description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session.", +"readOnly": true +}, "query": { "$ref": "GoogleCloudDiscoveryengineV1betaQuery", "description": "Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn" diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v4.json b/googleapiclient/discovery_cache/documents/displayvideo.v4.json index 512b1a5aa2..84ce5c96e0 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v4.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v4.json @@ -9302,7 +9302,7 @@ } } }, -"revision": "20250925", +"revision": "20250930", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -16375,7 +16375,8 @@ false "YOUTUBE_USERS", "THIRD_PARTY", "COMMERCE", -"LINEAR" +"LINEAR", +"AGENCY" ], "enumDeprecated": [ false, @@ -16388,6 +16389,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -16401,7 +16403,8 @@ false "Audience was created based on past interactions with videos, YouTube ads, or YouTube channel.", "Audience has been licensed for use from a third party.", "Audience provided by commerce partners for a fee.", -"Audience for Linear TV content." +"Audience for Linear TV content.", +"Audience provided by an agency." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/docs.v1.json b/googleapiclient/discovery_cache/documents/docs.v1.json index 98f197e993..52056c2506 100644 --- a/googleapiclient/discovery_cache/documents/docs.v1.json +++ b/googleapiclient/discovery_cache/documents/docs.v1.json @@ -221,7 +221,7 @@ } } }, -"revision": "20250917", +"revision": "20250925", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AutoText": { @@ -1753,6 +1753,25 @@ }, "type": "object" }, +"InsertPersonRequest": { +"description": "Inserts a person mention.", +"id": "InsertPersonRequest", +"properties": { +"endOfSegmentLocation": { +"$ref": "EndOfSegmentLocation", +"description": "Inserts the person at the end of a header, footer, footnote or the document body." +}, +"location": { +"$ref": "Location", +"description": "Inserts the person at a specific index in the document. The person mention must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). People cannot be inserted inside an equation." +}, +"personProperties": { +"$ref": "PersonProperties", +"description": "The properties of the person mention to insert." +} +}, +"type": "object" +}, "InsertSectionBreakRequest": { "description": "Inserts a section break at the given location. A newline character will be inserted before the section break.", "id": "InsertSectionBreakRequest", @@ -3075,6 +3094,10 @@ "$ref": "InsertPageBreakRequest", "description": "Inserts a page break at the specified location." }, +"insertPerson": { +"$ref": "InsertPersonRequest", +"description": "Inserts a person mention." +}, "insertSectionBreak": { "$ref": "InsertSectionBreakRequest", "description": "Inserts a section break at the specified location." diff --git a/googleapiclient/discovery_cache/documents/documentai.v1.json b/googleapiclient/discovery_cache/documents/documentai.v1.json index f951464bbf..40d155b478 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1.json @@ -320,6 +320,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}", @@ -1048,7 +1053,7 @@ } } }, -"revision": "20250922", +"revision": "20250929", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": { @@ -1067,10 +1072,16 @@ "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule": { "id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule", "properties": { +"childAlignmentRule": { +"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule" +}, "description": { "description": "Description of the validation rule. This has no use but for documentation", "type": "string" }, +"entityAlignmentRule": { +"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule" +}, "fieldOccurrences": { "$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences" }, @@ -1087,6 +1098,53 @@ }, "type": "object" }, +"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule": { +"description": "A rule for checking field alignment. Horizontal alignment checks if fields are on the same row by comparing y-coordinates of bounding box centers, while vertical alignment checks if fields are on the same column by comparing x-coordinates of bounding box centers.", +"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule", +"properties": { +"alignmentType": { +"enum": [ +"ALIGNMENT_TYPE_UNSPECIFIED", +"ALIGNMENT_TYPE_HORIZONTAL", +"ALIGNMENT_TYPE_VERTICAL" +], +"enumDescriptions": [ +"", +"", +"" +], +"type": "string" +}, +"tolerance": { +"description": "The tolerance to use when comparing coordinates.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule": { +"description": "A rule that aligns specified child fields with a parent field.", +"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule", +"properties": { +"alignmentRule": { +"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule", +"description": "The alignment rule to apply to the child fields." +}, +"childFields": { +"description": "The child fields to be aligned within the parent field.", +"items": { +"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField" +}, +"type": "array" +}, +"parentField": { +"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField", +"description": "The full path of the parent field." +} +}, +"type": "object" +}, "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant": { "description": "The constant value used in the validation rules.", "id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant", @@ -1098,6 +1156,24 @@ }, "type": "object" }, +"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule": { +"description": "A rule that aligns specified fields with each other.", +"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule", +"properties": { +"alignmentRule": { +"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule", +"description": "The alignment rule to apply to the fields." +}, +"fields": { +"description": "The fields to be aligned.", +"items": { +"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField" +}, +"type": "array" +} +}, +"type": "object" +}, "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField": { "id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField", "properties": { @@ -6235,6 +6311,13 @@ true "$ref": "GoogleLongrunningOperation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json index f533687b89..04bc2459ff 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json @@ -291,6 +291,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta3/{+name}", @@ -1290,7 +1295,7 @@ } } }, -"revision": "20250922", +"revision": "20250929", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": { @@ -1309,10 +1314,16 @@ "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule": { "id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule", "properties": { +"childAlignmentRule": { +"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule" +}, "description": { "description": "Description of the validation rule. This has no use but for documentation", "type": "string" }, +"entityAlignmentRule": { +"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule" +}, "fieldOccurrences": { "$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences" }, @@ -1329,6 +1340,53 @@ }, "type": "object" }, +"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule": { +"description": "A rule for checking field alignment. Horizontal alignment checks if fields are on the same row by comparing y-coordinates of bounding box centers, while vertical alignment checks if fields are on the same column by comparing x-coordinates of bounding box centers.", +"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule", +"properties": { +"alignmentType": { +"enum": [ +"ALIGNMENT_TYPE_UNSPECIFIED", +"ALIGNMENT_TYPE_HORIZONTAL", +"ALIGNMENT_TYPE_VERTICAL" +], +"enumDescriptions": [ +"", +"", +"" +], +"type": "string" +}, +"tolerance": { +"description": "The tolerance to use when comparing coordinates.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule": { +"description": "A rule that aligns specified child fields with a parent field.", +"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule", +"properties": { +"alignmentRule": { +"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule", +"description": "The alignment rule to apply to the child fields." +}, +"childFields": { +"description": "The child fields to be aligned within the parent field.", +"items": { +"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField" +}, +"type": "array" +}, +"parentField": { +"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField", +"description": "The full path of the parent field." +} +}, +"type": "object" +}, "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant": { "description": "The constant value used in the validation rules.", "id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant", @@ -1340,6 +1398,24 @@ }, "type": "object" }, +"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule": { +"description": "A rule that aligns specified fields with each other.", +"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule", +"properties": { +"alignmentRule": { +"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule", +"description": "The alignment rule to apply to the fields." +}, +"fields": { +"description": "The fields to be aligned.", +"items": { +"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField" +}, +"type": "array" +} +}, +"type": "object" +}, "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField": { "id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField", "properties": { @@ -7035,6 +7111,13 @@ true "$ref": "GoogleLongrunningOperation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/firebasehosting.v1.json b/googleapiclient/discovery_cache/documents/firebasehosting.v1.json index fc5ffea4cf..32579c666f 100644 --- a/googleapiclient/discovery_cache/documents/firebasehosting.v1.json +++ b/googleapiclient/discovery_cache/documents/firebasehosting.v1.json @@ -188,6 +188,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}", @@ -269,7 +274,7 @@ } } }, -"revision": "20241203", +"revision": "20250929", "rootUrl": "https://firebasehosting.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -541,6 +546,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json b/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json index 200bbce0da..3959361e4a 100644 --- a/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json @@ -946,6 +946,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -2422,7 +2427,7 @@ } } }, -"revision": "20240707", +"revision": "20250929", "rootUrl": "https://firebasehosting.googleapis.com/", "schemas": { "ActingUser": { @@ -3292,6 +3297,13 @@ false "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v1.json b/googleapiclient/discovery_cache/documents/firebaseml.v1.json index f7a9fc49fb..a761c75aed 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v1.json @@ -191,6 +191,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}", @@ -204,7 +209,7 @@ } } }, -"revision": "20241117", +"revision": "20250929", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -233,6 +238,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index 4928334903..66378de494 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20250922", +"revision": "20250930", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -460,7 +460,8 @@ "IMAGE_PROHIBITED_CONTENT", "IMAGE_RECITATION", "IMAGE_OTHER", -"UNEXPECTED_TOOL_CALL" +"UNEXPECTED_TOOL_CALL", +"NO_IMAGE" ], "enumDescriptions": [ "The finish reason is unspecified.", @@ -478,7 +479,8 @@ "Image generation stopped because generated images has other prohibited content.", "Image generation stopped due to recitation.", "Image generation stopped because of other miscellaneous issue.", -"The function call generated by the model is semantically invalid (e.g. a function call is generated when function calling is not enabled or the function is not in the function declaration)." +"The function call generated by the model is semantically invalid (e.g. a function call is generated when function calling is not enabled or the function is not in the function declaration).", +"The model was expected to generate an image, but none was generated." ], "readOnly": true, "type": "string" @@ -707,6 +709,28 @@ "description": "Tool to search public web data, powered by Vertex AI Search and Sec4 compliance.", "id": "GoogleCloudAiplatformV1beta1EnterpriseWebSearch", "properties": { +"blockingConfidence": { +"description": "Optional. Sites with confidence level chosen & above this value will be blocked from the search results.", +"enum": [ +"PHISH_BLOCK_THRESHOLD_UNSPECIFIED", +"BLOCK_LOW_AND_ABOVE", +"BLOCK_MEDIUM_AND_ABOVE", +"BLOCK_HIGH_AND_ABOVE", +"BLOCK_HIGHER_AND_ABOVE", +"BLOCK_VERY_HIGH_AND_ABOVE", +"BLOCK_ONLY_EXTREMELY_HIGH" +], +"enumDescriptions": [ +"Defaults to unspecified.", +"Blocks Low and above confidence URL that is risky.", +"Blocks Medium and above confidence URL that is risky.", +"Blocks High and above confidence URL that is risky.", +"Blocks Higher and above confidence URL that is risky.", +"Blocks Very high and above confidence URL that is risky.", +"Blocks Extremely high confidence URL that is risky." +], +"type": "string" +}, "excludeDomains": { "description": "Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.", "items": { @@ -1185,6 +1209,10 @@ "format": "float", "type": "number" }, +"imageConfig": { +"$ref": "GoogleCloudAiplatformV1beta1ImageConfig", +"description": "Optional. Config for image generation features." +}, "logprobs": { "description": "Optional. Logit probabilities.", "format": "int32", @@ -1633,6 +1661,17 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ImageConfig": { +"description": "Config for image generation features.", +"id": "GoogleCloudAiplatformV1beta1ImageConfig", +"properties": { +"aspectRatio": { +"description": "Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: \"1:1\" \"2:3\", \"3:2\" \"3:4\", \"4:3\" \"4:5\", \"5:4\" \"9:16\", \"16:9\" \"21:9\"", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1LogprobsResult": { "description": "Logprobs Result", "id": "GoogleCloudAiplatformV1beta1LogprobsResult", @@ -2465,6 +2504,28 @@ false "description": "GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.", "id": "GoogleCloudAiplatformV1beta1ToolGoogleSearch", "properties": { +"blockingConfidence": { +"description": "Optional. Sites with confidence level chosen & above this value will be blocked from the search results.", +"enum": [ +"PHISH_BLOCK_THRESHOLD_UNSPECIFIED", +"BLOCK_LOW_AND_ABOVE", +"BLOCK_MEDIUM_AND_ABOVE", +"BLOCK_HIGH_AND_ABOVE", +"BLOCK_HIGHER_AND_ABOVE", +"BLOCK_VERY_HIGH_AND_ABOVE", +"BLOCK_ONLY_EXTREMELY_HIGH" +], +"enumDescriptions": [ +"Defaults to unspecified.", +"Blocks Low and above confidence URL that is risky.", +"Blocks Medium and above confidence URL that is risky.", +"Blocks High and above confidence URL that is risky.", +"Blocks Higher and above confidence URL that is risky.", +"Blocks Very high and above confidence URL that is risky.", +"Blocks Extremely high confidence URL that is risky." +], +"type": "string" +}, "excludeDomains": { "description": "Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: [\"amazon.com\", \"facebook.com\"].", "items": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json index cbed262da8..da332855c7 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json @@ -1463,6 +1463,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -2117,7 +2122,7 @@ } } }, -"revision": "20250907", +"revision": "20250925", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -4843,6 +4848,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json index 6f4ff5e06f..f2cc9b2feb 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json @@ -1607,6 +1607,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -2261,7 +2266,7 @@ } } }, -"revision": "20250907", +"revision": "20250925", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -5241,6 +5246,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json index 6fc105c3d4..785d5a8072 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json @@ -1463,6 +1463,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -2117,7 +2122,7 @@ } } }, -"revision": "20250907", +"revision": "20250925", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -4904,6 +4909,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json index d094898a92..e5e8adb97b 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json @@ -701,6 +701,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -718,7 +723,7 @@ } } }, -"revision": "20250907", +"revision": "20250925", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "ApplianceCluster": { @@ -1100,6 +1105,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2.json b/googleapiclient/discovery_cache/documents/gkehub.v2.json index 6abd3ae13f..57b78086e0 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2.json @@ -460,6 +460,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2/{+name}/operations", @@ -477,7 +482,7 @@ } } }, -"revision": "20250907", +"revision": "20250925", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -2331,6 +2336,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json index 20be31722b..a1fc56769d 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json @@ -460,6 +460,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2alpha/{+name}/operations", @@ -477,7 +482,7 @@ } } }, -"revision": "20250907", +"revision": "20250925", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -2331,6 +2336,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2beta.json b/googleapiclient/discovery_cache/documents/gkehub.v2beta.json index aa0bb9d11e..5e15ffdc21 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2beta.json @@ -460,6 +460,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2beta/{+name}/operations", @@ -477,7 +482,7 @@ } } }, -"revision": "20250907", +"revision": "20250925", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -2331,6 +2336,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1.json b/googleapiclient/discovery_cache/documents/healthcare.v1.json index 7ddf695c1a..53f8d9bdd5 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1.json @@ -2022,7 +2022,7 @@ ] }, "searchForInstances": { -"description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", +"description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/instances", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.searchForInstances", @@ -2056,7 +2056,7 @@ ] }, "searchForSeries": { -"description": "SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", +"description": "SearchForSeries returns a list of matching series. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/series", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.searchForSeries", @@ -2090,7 +2090,7 @@ ] }, "searchForStudies": { -"description": "SearchForStudies returns a list of matching studies. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", +"description": "SearchForStudies returns a list of matching studies. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.searchForStudies", @@ -2182,7 +2182,7 @@ ] }, "storeInstances": { -"description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", +"description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.storeInstances", @@ -2412,7 +2412,7 @@ ] }, "retrieveMetadata": { -"description": "RetrieveStudyMetadata returns instance associated with the given study presented as metadata. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", +"description": "RetrieveStudyMetadata returns instance associated with the given study presented as metadata. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/metadata", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.retrieveMetadata", @@ -2446,7 +2446,7 @@ ] }, "retrieveStudy": { -"description": "RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", +"description": "RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.retrieveStudy", @@ -2480,7 +2480,7 @@ ] }, "searchForInstances": { -"description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", +"description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/instances", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.searchForInstances", @@ -2514,7 +2514,7 @@ ] }, "searchForSeries": { -"description": "SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", +"description": "SearchForSeries returns a list of matching series. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.searchForSeries", @@ -2548,7 +2548,7 @@ ] }, "storeInstances": { -"description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", +"description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.studies.storeInstances", @@ -2623,7 +2623,7 @@ ] }, "retrieveMetadata": { -"description": "RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", +"description": "RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/metadata", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveMetadata", @@ -2657,7 +2657,7 @@ ] }, "retrieveSeries": { -"description": "RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", +"description": "RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveSeries", @@ -2691,7 +2691,7 @@ ] }, "searchForInstances": { -"description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", +"description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.searchForInstances", @@ -2763,7 +2763,7 @@ ] }, "retrieveInstance": { -"description": "RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance).", +"description": "RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveInstance", @@ -2797,7 +2797,7 @@ ] }, "retrieveMetadata": { -"description": "RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", +"description": "RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/metadata", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveMetadata", @@ -2831,7 +2831,7 @@ ] }, "retrieveRendered": { -"description": "RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", +"description": "RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/rendered", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveRendered", @@ -2874,7 +2874,7 @@ "bulkdata": { "methods": { "retrieveBulkdata": { -"description": "Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See [Retrieve Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveBulkdata, see [Bulkdata resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see [Retrieve bulkdata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-bulkdata).", +"description": "Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See [Retrieve Transaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveBulkdata, see [Bulkdata resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see [Retrieve bulkdata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-bulkdata).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/bulkdata/{bulkdataId}/{bulkdataId1}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.bulkdata.retrieveBulkdata", @@ -2912,7 +2912,7 @@ "frames": { "methods": { "retrieveFrames": { -"description": "RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", +"description": "RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveFrames", @@ -2946,7 +2946,7 @@ ] }, "retrieveRendered": { -"description": "RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", +"description": "RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}/rendered", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered", @@ -5132,7 +5132,7 @@ } } }, -"revision": "20250904", +"revision": "20250923", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -6140,7 +6140,7 @@ "enumDescriptions": [ "No tag filtration profile provided. Same as KEEP_ALL_PROFILE.", "Keep only tags required to produce valid DICOM.", -"Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e) http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html.", +"Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e) https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html.", "Keep all tags.", "Inspects within tag contents and replaces sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following Value Representation names: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS" ], @@ -6155,7 +6155,7 @@ "description": "List of tags to remove. Keep all other tags." }, "skipIdRedaction": { -"description": "Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: \"Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity.\" http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html", +"description": "Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: \"Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity.\" https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html", "type": "boolean" } }, @@ -8716,7 +8716,7 @@ "id": "TagFilterList", "properties": { "tags": { -"description": "Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by \"Keyword\" or \"Tag\". For example \"PatientID\", \"00100010\".", +"description": "Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by \"Keyword\" or \"Tag\". For example \"PatientID\", \"00100010\".", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json index aa9311f9d8..38c131693c 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json @@ -2022,7 +2022,7 @@ ] }, "searchForInstances": { -"description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", +"description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/instances", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.searchForInstances", @@ -2056,7 +2056,7 @@ ] }, "searchForSeries": { -"description": "SearchForSeries returns a list of matching series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", +"description": "SearchForSeries returns a list of matching series. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/series", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.searchForSeries", @@ -2090,7 +2090,7 @@ ] }, "searchForStudies": { -"description": "SearchForStudies returns a list of matching studies. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", +"description": "SearchForStudies returns a list of matching studies. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.searchForStudies", @@ -2182,7 +2182,7 @@ ] }, "storeInstances": { -"description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", +"description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.storeInstances", @@ -2449,7 +2449,7 @@ ] }, "retrieveMetadata": { -"description": "RetrieveStudyMetadata returns instance associated with the given study presented as metadata. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", +"description": "RetrieveStudyMetadata returns instance associated with the given study presented as metadata. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/metadata", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.retrieveMetadata", @@ -2483,7 +2483,7 @@ ] }, "retrieveStudy": { -"description": "RetrieveStudy returns all instances within the given study. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", +"description": "RetrieveStudy returns all instances within the given study. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.retrieveStudy", @@ -2517,7 +2517,7 @@ ] }, "searchForInstances": { -"description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", +"description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/instances", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.searchForInstances", @@ -2551,7 +2551,7 @@ ] }, "searchForSeries": { -"description": "SearchForSeries returns a list of matching series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", +"description": "SearchForSeries returns a list of matching series. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.searchForSeries", @@ -2585,7 +2585,7 @@ ] }, "storeInstances": { -"description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", +"description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.studies.storeInstances", @@ -2734,7 +2734,7 @@ ] }, "retrieveMetadata": { -"description": "RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", +"description": "RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/metadata", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveMetadata", @@ -2768,7 +2768,7 @@ ] }, "retrieveSeries": { -"description": "RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", +"description": "RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveSeries", @@ -2802,7 +2802,7 @@ ] }, "searchForInstances": { -"description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", +"description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.searchForInstances", @@ -2911,7 +2911,7 @@ ] }, "retrieveInstance": { -"description": "RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance).", +"description": "RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveInstance", @@ -2945,7 +2945,7 @@ ] }, "retrieveMetadata": { -"description": "RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", +"description": "RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/metadata", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveMetadata", @@ -2979,7 +2979,7 @@ ] }, "retrieveRendered": { -"description": "RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", +"description": "RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/rendered", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveRendered", @@ -3059,7 +3059,7 @@ "bulkdata": { "methods": { "retrieveBulkdata": { -"description": "Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See [Retrieve Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveBulkdata, see [Bulkdata resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see [Retrieve bulkdata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-bulkdata).", +"description": "Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See [Retrieve Transaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveBulkdata, see [Bulkdata resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see [Retrieve bulkdata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-bulkdata).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/bulkdata/{bulkdataId}/{bulkdataId1}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.bulkdata.retrieveBulkdata", @@ -3097,7 +3097,7 @@ "frames": { "methods": { "retrieveFrames": { -"description": "RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", +"description": "RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveFrames", @@ -3131,7 +3131,7 @@ ] }, "retrieveRendered": { -"description": "RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", +"description": "RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}/rendered", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered", @@ -5679,7 +5679,7 @@ } } }, -"revision": "20250904", +"revision": "20250923", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -5711,7 +5711,7 @@ "properties": { "cleanImageTag": { "$ref": "ImageConfig", -"description": "Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData" +"description": "Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData" }, "cleanTextTag": { "$ref": "CleanTextTag", @@ -5734,11 +5734,11 @@ }, "recurseTag": { "$ref": "RecurseTag", -"description": "Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ" +"description": "Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ" }, "regenUidTag": { "$ref": "RegenUidTag", -"description": "Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI" +"description": "Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI" }, "removeTag": { "$ref": "RemoveTag", @@ -6270,7 +6270,7 @@ "type": "object" }, "CleanDescriptorsOption": { -"description": "This option is based on the DICOM Standard's [Clean Descriptors Option](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token \"[CTX]\". This option uses an additional infoType during inspection.", +"description": "This option is based on the DICOM Standard's [Clean Descriptors Option](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token \"[CTX]\". This option uses an additional infoType during inspection.", "id": "CleanDescriptorsOption", "properties": {}, "type": "object" @@ -6282,7 +6282,7 @@ "type": "object" }, "CleanTextTag": { -"description": "Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS", +"description": "Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS", "id": "CleanTextTag", "properties": {}, "type": "object" @@ -6839,7 +6839,7 @@ "enumDescriptions": [ "No tag filtration profile provided. Same as KEEP_ALL_PROFILE.", "Keep only the tags required to produce valid DICOM objects.", -"Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e) http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html.", +"Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e) https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html.", "Keep all tags.", "Inspect within tag contents and replace sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following Value Representation names: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS" ], @@ -6854,7 +6854,7 @@ "description": "List of tags to remove. Keep all other tags." }, "skipIdRedaction": { -"description": "If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: \"Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity.\" http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html", +"description": "If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: \"Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity.\" https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html", "type": "boolean" } }, @@ -6981,9 +6981,9 @@ "enumDescriptions": [ "No profile provided. Same as `ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE`.", "Keep only the tags required to produce valid DICOM objects.", -"Remove tags based on DICOM Standard's [Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e)](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html).", +"Remove tags based on DICOM Standard's [Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e)](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html).", "Keep all tags.", -"Inspect tag contents and replace sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS" +"Inspect tag contents and replace sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following [Value Representations] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS" ], "type": "string" } @@ -8903,10 +8903,10 @@ }, "cleanImage": { "$ref": "ImageConfig", -"description": "Apply `Action.clean_image` to [`PixelData`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured." +"description": "Apply `Action.clean_image` to [`PixelData`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured." }, "primaryIds": { -"description": "Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html).", +"description": "Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html).", "enum": [ "PRIMARY_IDS_OPTION_UNSPECIFIED", "KEEP", @@ -9114,7 +9114,7 @@ "type": "object" }, "RecurseTag": { -"description": "Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ", +"description": "Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ", "id": "RecurseTag", "properties": {}, "type": "object" @@ -9126,7 +9126,7 @@ "type": "object" }, "RegenUidTag": { -"description": "Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI", +"description": "Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI", "id": "RegenUidTag", "properties": {}, "type": "object" @@ -9799,7 +9799,7 @@ "id": "TagFilterList", "properties": { "tags": { -"description": "Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by \"Keyword\" or \"Tag\". For example, \"PatientID\", \"00100010\".", +"description": "Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by \"Keyword\" or \"Tag\". For example, \"PatientID\", \"00100010\".", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/iam.v1.json b/googleapiclient/discovery_cache/documents/iam.v1.json index c266ad4e60..64998b2d47 100644 --- a/googleapiclient/discovery_cache/documents/iam.v1.json +++ b/googleapiclient/discovery_cache/documents/iam.v1.json @@ -864,7 +864,7 @@ "scimTenants": { "methods": { "create": { -"description": "Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted scim tenant until 30 days after deletion.", +"description": "Agentspace only. Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted SCIM tenant until 30 days after deletion.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants", "httpMethod": "POST", "id": "iam.locations.workforcePools.providers.scimTenants.create", @@ -873,14 +873,14 @@ ], "parameters": { "parent": { -"description": "Required. The parent to create scim tenant. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}'", +"description": "Required. Agentspace only. The parent to create SCIM tenant. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}'", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+$", "required": true, "type": "string" }, "workforcePoolProviderScimTenantId": { -"description": "Required. The ID to use for the scim tenant, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-].", +"description": "Required. Agentspace only. The ID to use for the SCIM tenant, which becomes the final component of the resource name. This value should be 4-32 characters, containing the characters [a-z0-9-].", "location": "query", "type": "string" } @@ -897,7 +897,7 @@ ] }, "delete": { -"description": "Deletes a WorkforcePoolProviderScimTenant. You can undelete a scim tenant for 30 days. After 30 days, deletion is permanent. You cannot update deleted scim tenants. However, you can view and list them.", +"description": "Agentspace only. Deletes a WorkforcePoolProviderScimTenant. You can undelete a SCIM tenant for 30 days. After 30 days, deletion is permanent. You cannot update deleted SCIM tenants. However, you can view and list them.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}", "httpMethod": "DELETE", "id": "iam.locations.workforcePools.providers.scimTenants.delete", @@ -906,7 +906,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the scim tenant to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}`", +"description": "Required. Agentspace only. The name of the scim tenant to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$", "required": true, @@ -922,7 +922,7 @@ ] }, "get": { -"description": "Gets an individual WorkforcePoolProviderScimTenant.", +"description": "Agentspace only. Gets an individual WorkforcePoolProviderScimTenant.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}", "httpMethod": "GET", "id": "iam.locations.workforcePools.providers.scimTenants.get", @@ -931,7 +931,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the scim tenant to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}`", +"description": "Required. Agentspace only. The name of the SCIM tenant to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$", "required": true, @@ -947,7 +947,7 @@ ] }, "list": { -"description": "Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted scim tenants are also listed.", +"description": "Agentspace only. Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted SCIM tenants are also listed.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants", "httpMethod": "GET", "id": "iam.locations.workforcePools.providers.scimTenants.list", @@ -956,25 +956,25 @@ ], "parameters": { "pageSize": { -"description": "Optional. The maximum number of scim tenants to return. If unspecified, at most 1 scim tenant will be returned.", +"description": "Optional. Agentspace only. The maximum number of SCIM tenants to return. If unspecified, at most 1 scim tenant will be returned.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. A page token, received from a previous `ListScimTenants` call. Provide this to retrieve the subsequent page.", +"description": "Optional. Agentspace only. A page token, received from a previous `ListScimTenants` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent to list scim tenants. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}'", +"description": "Required. Agentspace only. The parent to list SCIM tenants. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}'", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+$", "required": true, "type": "string" }, "showDeleted": { -"description": "Optional. Whether to return soft-deleted scim tenants.", +"description": "Optional. Agentspace only. Whether to return soft-deleted SCIM tenants.", "location": "query", "type": "boolean" } @@ -988,7 +988,7 @@ ] }, "patch": { -"description": "Updates an existing WorkforcePoolProviderScimTenant.", +"description": "Agentspace only. Updates an existing WorkforcePoolProviderScimTenant.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}", "httpMethod": "PATCH", "id": "iam.locations.workforcePools.providers.scimTenants.patch", @@ -997,14 +997,14 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`", +"description": "Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "Optional. The list of fields to update.", +"description": "Optional. Agentspace only. The list of fields to update.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1022,7 +1022,7 @@ ] }, "undelete": { -"description": "Undeletes a WorkforcePoolProviderScimTenant, as long as it was deleted fewer than 30 days ago.", +"description": "Agentspace only. Undeletes a WorkforcePoolProviderScimTenant, that was deleted fewer than 30 days ago.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}:undelete", "httpMethod": "POST", "id": "iam.locations.workforcePools.providers.scimTenants.undelete", @@ -1031,7 +1031,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the scim tenant to undelete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}`", +"description": "Required. Agentspace only. The name of the SCIM tenant to undelete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$", "required": true, @@ -1054,7 +1054,7 @@ "tokens": { "methods": { "create": { -"description": "Creates a new WorkforcePoolProviderScimToken in a WorkforcePoolProviderScimTenant. You cannot reuse the name of a deleted SCIM token until 30 days after deletion.", +"description": "Agentspace only. Creates a new WorkforcePoolProviderScimToken in a WorkforcePoolProviderScimTenant. You cannot reuse the name of a deleted SCIM token until 30 days after deletion.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens", "httpMethod": "POST", "id": "iam.locations.workforcePools.providers.scimTenants.tokens.create", @@ -1063,14 +1063,14 @@ ], "parameters": { "parent": { -"description": "Required. The parent tenant to create scim token. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}'", +"description": "Required. Agentspace only. The parent tenant to create SCIM token. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}'", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$", "required": true, "type": "string" }, "workforcePoolProviderScimTokenId": { -"description": "Required. The ID to use for the scim token, which becomes the final component of the resource name. This value should be 4-32 characters and follow this pattern: \"([a-z]([a-z0-9\\\\-]{2,30}[a-z0-9]))\"", +"description": "Required. Agentspace only. The ID to use for the SCIM token, which becomes the final component of the resource name. This value should be 4-32 characters and follow the pattern: \"([a-z]([a-z0-9\\\\-]{2,30}[a-z0-9]))\"", "location": "query", "type": "string" } @@ -1087,7 +1087,7 @@ ] }, "delete": { -"description": "Deletes a WorkforcePoolProviderScimToken. You can undelete a scim token for 30 days. After 30 days, deletion is permanent. You cannot update deleted scim tokens. However, you can view and list them.", +"description": "Agentspace only. Deletes a WorkforcePoolProviderScimToken. You can undelete a SCIM token for 30 days. After 30 days, the SCIM token is permanently deleted. You cannot update deleted SCIM tokens, however, you can view and list them.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens/{tokensId}", "httpMethod": "DELETE", "id": "iam.locations.workforcePools.providers.scimTenants.tokens.delete", @@ -1096,7 +1096,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the scim token to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}`", +"description": "Required. Agentspace only. The name of the SCIM token to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+/tokens/[^/]+$", "required": true, @@ -1112,7 +1112,7 @@ ] }, "get": { -"description": "Gets an individual WorkforcePoolProviderScimToken.", +"description": "Agentspace only. Gets an individual WorkforcePoolProviderScimToken.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens/{tokensId}", "httpMethod": "GET", "id": "iam.locations.workforcePools.providers.scimTenants.tokens.get", @@ -1121,7 +1121,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the scim token to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}`", +"description": "Required. Agentspace only. The name of the SCIM token to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+/tokens/[^/]+$", "required": true, @@ -1137,7 +1137,7 @@ ] }, "list": { -"description": "Lists all non-deleted WorkforcePoolProviderScimTokenss in a WorkforcePoolProviderScimTenant. If `show_deleted` is set to `true`, then deleted SCIM tokens are also listed.", +"description": "Agentspace only. Lists all non-deleted WorkforcePoolProviderScimTokenss in a WorkforcePoolProviderScimTenant. If `show_deleted` is set to `true`, then deleted SCIM tokens are also listed.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens", "httpMethod": "GET", "id": "iam.locations.workforcePools.providers.scimTenants.tokens.list", @@ -1146,25 +1146,25 @@ ], "parameters": { "pageSize": { -"description": "Optional. The maximum number of scim tokens to return. If unspecified, at most 2 scim tokens will be returned.", +"description": "Optional. Agentspace only. The maximum number of scim tokens to return. If unspecified, at most 2 SCIM tokens will be returned.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. A page token, received from a previous `ListWorkforcePoolProviderScimTokens` call. Provide this to retrieve the subsequent page.", +"description": "Optional. Agentspace only. A page token, received from a previous `ListWorkforcePoolProviderScimTokens` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent to list scim tokens. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}'", +"description": "Required. Agentspace only. The parent to list SCIM tokens. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}'", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$", "required": true, "type": "string" }, "showDeleted": { -"description": "Optional. Whether to return soft-deleted scim tokens.", +"description": "Optional. Agentspace only. Whether to return soft-deleted scim tokens.", "location": "query", "type": "boolean" } @@ -1178,7 +1178,7 @@ ] }, "patch": { -"description": "Updates an existing WorkforcePoolProviderScimToken.", +"description": "Agentspace only. Updates an existing WorkforcePoolProviderScimToken.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens/{tokensId}", "httpMethod": "PATCH", "id": "iam.locations.workforcePools.providers.scimTenants.tokens.patch", @@ -1187,14 +1187,14 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`", +"description": "Identifier. Agentspace only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+/tokens/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "Optional. The list of fields to update.", +"description": "Optional. Agentspace only. The list of fields to update.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1212,7 +1212,7 @@ ] }, "undelete": { -"description": "Undeletes a WorkforcePoolProviderScimToken, as long as it was deleted fewer than 30 days ago.", +"description": "Agentspace only. Undeletes a WorkforcePoolProviderScimToken,that was deleted fewer than 30 days ago.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens/{tokensId}:undelete", "httpMethod": "POST", "id": "iam.locations.workforcePools.providers.scimTenants.tokens.undelete", @@ -1221,7 +1221,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the scim token to undelete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}`", +"description": "Required. Agentspace only. The name of the SCIM token to undelete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+/tokens/[^/]+$", "required": true, @@ -2578,7 +2578,7 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the managed identity.", +"description": "Output only. The resource name of the managed identity.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+$", "required": true, @@ -2948,7 +2948,7 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the provider.", +"description": "Output only. The resource name of the provider.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/providers/[^/]+$", "required": true, @@ -4155,7 +4155,7 @@ } } }, -"revision": "20250919", +"revision": "20250925", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -5013,15 +5013,15 @@ "type": "object" }, "ListWorkforcePoolProviderScimTenantsResponse": { -"description": "Response message for ListWorkforcePoolProviderScimTenants.", +"description": "Agentspace only. Response message for ListWorkforcePoolProviderScimTenants.", "id": "ListWorkforcePoolProviderScimTenantsResponse", "properties": { "nextPageToken": { -"description": "Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"description": "Optional. Agentspace only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "workforcePoolProviderScimTenants": { -"description": "Output only. A list of scim tenants.", +"description": "Output only. Agentspace only. A list of SCIM tenants.", "items": { "$ref": "WorkforcePoolProviderScimTenant" }, @@ -5032,15 +5032,15 @@ "type": "object" }, "ListWorkforcePoolProviderScimTokensResponse": { -"description": "Response message for ListWorkforcePoolProviderScimTokens.", +"description": "Agentspace only. Response message for ListWorkforcePoolProviderScimTokens.", "id": "ListWorkforcePoolProviderScimTokensResponse", "properties": { "nextPageToken": { -"description": "Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"description": "Optional. Agentspace only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "workforcePoolProviderScimTokens": { -"description": "Output only. A list of scim tokens.", +"description": "Output only. Agentspace only. A list of SCIM tokens.", "items": { "$ref": "WorkforcePoolProviderScimToken" }, @@ -6168,13 +6168,13 @@ false "type": "object" }, "UndeleteWorkforcePoolProviderScimTenantRequest": { -"description": "Request message for UndeleteWorkforcePoolProviderScimTenant.", +"description": "Agentspace only. Request message for UndeleteWorkforcePoolProviderScimTenant.", "id": "UndeleteWorkforcePoolProviderScimTenantRequest", "properties": {}, "type": "object" }, "UndeleteWorkforcePoolProviderScimTokenRequest": { -"description": "Request message for UndeleteWorkforcePoolProviderScimToken.", +"description": "Agentspace only. Request message for UndeleteWorkforcePoolProviderScimToken.", "id": "UndeleteWorkforcePoolProviderScimTokenRequest", "properties": {}, "type": "object" @@ -6302,7 +6302,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters, The key must match the regex \"^a-zA-Z0-9._{0,31}$\". This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 4KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {\"google.subject\": \"assertion.sub\"} ```", +"description": "Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters, The key must match the regex \"^a-zA-Z0-9._{0,31}$\". This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 16 KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {\"google.subject\": \"assertion.sub\"} ```", "type": "object" }, "description": { @@ -6414,11 +6414,11 @@ false "type": "object" }, "WorkforcePoolProviderScimTenant": { -"description": "Represents a scim tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.", +"description": "Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.", "id": "WorkforcePoolProviderScimTenant", "properties": { "baseUri": { -"description": "Output only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/", +"description": "Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/", "readOnly": true, "type": "string" }, @@ -6426,38 +6426,43 @@ false "additionalProperties": { "type": "string" }, -"description": "Optional. Maps BYOID claims to SCIM claims.", +"description": "Optional. Agentspace only. Maps BYOID claims to SCIM claims.", "type": "object" }, "description": { -"description": "Optional. The description of the scim tenant. Cannot exceed 256 characters.", +"description": "Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters.", "type": "string" }, "displayName": { -"description": "Optional. The display name of the scim tenant. Cannot exceed 32 characters.", +"description": "Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters.", "type": "string" }, "name": { -"description": "Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`", +"description": "Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`", "type": "string" }, "purgeTime": { -"description": "Output only. The timestamp when the scim tenant is going to be purged.", +"description": "Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.", "format": "google-datetime", "readOnly": true, "type": "string" }, +"serviceAgent": { +"description": "Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.", +"readOnly": true, +"type": "string" +}, "state": { -"description": "Output only. The state of the tenant.", +"description": "Output only. Agentspace only. The state of the tenant.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "DELETED" ], "enumDescriptions": [ -"State unspecified.", -"The tenant is active and may be used to provision users and groups.", -"The tenant is soft-deleted. Soft-deleted tenants are permanently deleted after approximately 30 days." +"Agentspace only. State unspecified.", +"Agentspace only. The tenant is active and may be used to provision users and groups.", +"Agentspace only. The tenant is soft-deleted. Soft-deleted tenants are permanently deleted after approximately 30 days." ], "readOnly": true, "type": "string" @@ -6466,33 +6471,33 @@ false "type": "object" }, "WorkforcePoolProviderScimToken": { -"description": "Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests.", +"description": "Agentspace only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests.", "id": "WorkforcePoolProviderScimToken", "properties": { "displayName": { -"description": "Optional. The display name of the scim token. Cannot exceed 32 characters.", +"description": "Optional. Agentspace only. The display name of the SCIM token. Cannot exceed 32 characters.", "type": "string" }, "name": { -"description": "Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`", +"description": "Identifier. Agentspace only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`", "type": "string" }, "securityToken": { -"description": "Output only. The token string. Provide this to the IdP for authentication. Will be set only during creation.", +"description": "Output only. Agentspace only. The token string. Provide this to the IdP for authentication. Will be set only during creation.", "readOnly": true, "type": "string" }, "state": { -"description": "Output only. The state of the token.", +"description": "Output only. Agentspace only. The state of the token.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "DELETED" ], "enumDescriptions": [ -"State unspecified.", -"The tenant is active and may be used to provision users and groups.", -"The tenant is soft-deleted. Soft-deleted tenants are permanently deleted after approximately 30 days." +"Agentspace only. State unspecified.", +"Agentspace only. The token is active and may be used to provision users and groups.", +"Agentspace only. The token is soft-deleted. Soft-deleted tokens are permanently deleted after approximately 30 days." ], "readOnly": true, "type": "string" @@ -6586,7 +6591,8 @@ false "type": "string" }, "name": { -"description": "Identifier. The resource name of the managed identity.", +"description": "Output only. The resource name of the managed identity.", +"readOnly": true, "type": "string" }, "state": { @@ -6697,7 +6703,8 @@ false "type": "string" }, "name": { -"description": "Identifier. The resource name of the provider.", +"description": "Output only. The resource name of the provider.", +"readOnly": true, "type": "string" }, "oidc": { diff --git a/googleapiclient/discovery_cache/documents/metastore.v1.json b/googleapiclient/discovery_cache/documents/metastore.v1.json index 9bc91bfb3a..283a706053 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1.json @@ -563,6 +563,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1690,7 +1695,7 @@ } } }, -"revision": "20250911", +"revision": "20250925", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2579,6 +2584,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json index c543cdac31..d39e281d48 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json @@ -563,6 +563,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -1802,7 +1807,7 @@ } } }, -"revision": "20250911", +"revision": "20250925", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2768,6 +2773,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/metastore.v1beta.json b/googleapiclient/discovery_cache/documents/metastore.v1beta.json index fb237b0329..04c6752f11 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1beta.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1beta.json @@ -563,6 +563,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -1802,7 +1807,7 @@ } } }, -"revision": "20250911", +"revision": "20250925", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2768,6 +2773,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1.json index 2e5685f86a..2b51a4ede6 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1.json @@ -2412,7 +2412,7 @@ } } }, -"revision": "20250928", +"revision": "20250930", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -2425,7 +2425,7 @@ }, "assets": { "$ref": "AssetList", -"description": "Required. List of assets to be added. The maximum number of assets that can be added in a single request is 1000." +"description": "Required. List of assets to be added. The maximum number of assets that can be added in a single request is 2000." }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json index 0ebe62fd5f..5537f9c0af 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json @@ -1680,6 +1680,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1alpha1/{+name}/operations", @@ -2554,7 +2559,7 @@ } } }, -"revision": "20250917", +"revision": "20250930", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -2567,7 +2572,7 @@ }, "assets": { "$ref": "AssetList", -"description": "Required. List of assets to be added. The maximum number of assets that can be added in a single request is 1000." +"description": "Required. List of assets to be added. The maximum number of assets that can be added in a single request is 2000." }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", @@ -6268,6 +6273,13 @@ false "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json index c4b8160e82..8f9b526c0d 100644 --- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json @@ -109,6 +109,34 @@ "resources": { "locations": { "methods": { +"checkConsumerConfig": { +"description": "CheckConsumerConfig validates the consumer network and project for potential PSC connection creation. This method performs several checks, including: - Validating the existence and permissions of the service class. - Ensuring the consumer network exists and is accessible. - Verifying XPN relationships if applicable. - Checking for compatible IP versions between the consumer network and the requested version. This method performs a dynamic IAM check for the `networkconnectivity.serviceClasses.use` permission on the service class resource in the Prepare phase.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:checkConsumerConfig", +"httpMethod": "POST", +"id": "networkconnectivity.projects.locations.checkConsumerConfig", +"parameterOrder": [ +"location" +], +"parameters": { +"location": { +"description": "Required. The location resource path. Example: - projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+location}:checkConsumerConfig", +"request": { +"$ref": "CheckConsumerConfigRequest" +}, +"response": { +"$ref": "CheckConsumerConfigResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets information about a location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", @@ -2102,6 +2130,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -3763,7 +3796,7 @@ } } }, -"revision": "20250910", +"revision": "20250925", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { @@ -3952,6 +3985,77 @@ }, "type": "object" }, +"CheckConsumerConfigRequest": { +"description": "Request for CheckConsumerConfig.", +"id": "CheckConsumerConfigRequest", +"properties": { +"consumerNetwork": { +"description": "Required. Full resource name of the consumer network. Example: - projects/{project}/global/networks/{network}.", +"type": "string" +}, +"endpointProject": { +"description": "The project number or ID where the PSC endpoint is to be created.", +"type": "string" +}, +"requestedIpVersion": { +"description": "The requested IP Version", +"enum": [ +"IP_VERSION_UNSPECIFIED", +"IPV4", +"IPV6" +], +"enumDescriptions": [ +"Default value. We will use IPv4 or IPv6 depending on the IP version of first available subnetwork.", +"Will use IPv4 only.", +"Will use IPv6 only." +], +"type": "string" +}, +"serviceClass": { +"description": "Required. The service class identifier of the producer.", +"type": "string" +} +}, +"type": "object" +}, +"CheckConsumerConfigResponse": { +"description": "Response for CheckConsumerConfig.", +"id": "CheckConsumerConfigResponse", +"properties": { +"errors": { +"description": "List of validation errors. If the list is empty, the consumer config is valid.", +"items": { +"enum": [ +"ERROR_UNSPECIFIED", +"NETWORK_PROJECT_INVALID", +"NETWORK_PROJECT_APIS_NOT_ENABLED", +"NETWORK_INVALID", +"CONNECTION_POLICY_MISSING", +"IP_VERSION_NOT_SUPPORTED", +"NETWORK_PROJECT_SERVICE_AGENT_NOT_FOUND", +"ENDPOINT_PROJECT_INVALID", +"ENDPOINT_PROJECT_API_NOT_ENABLED", +"ENDPOINT_PROJECT_IS_NOT_SERVICE_PROJECT" +], +"enumDescriptions": [ +"An invalid error as the default case.", +"Invalid Network project.", +"Network Connectivity APIs not enabled in network project.", +"Invalid network.", +"No ServiceConnectionPolicy found for this network and ServiceClass.", +"IP version not supported in any of the subnetworks.", +"Service Agent missing for network project.", +"Invalid endpoint project.", +"Network Connectivity API is not enabled in the endpoint project.", +"Endpoint project is not a service project of the network project." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ConsumerPscConfig": { "description": "Allow the producer to specify which consumers can connect to it.", "id": "ConsumerPscConfig", @@ -4321,6 +4425,13 @@ "$ref": "GoogleLongrunningOperation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -6103,7 +6214,7 @@ "type": "string" }, "network": { -"description": "The name of the VPC network for this private regional endpoint. Format: `projects/{project}/global/networks/{network}`", +"description": "Optional. The name of the VPC network for this private regional endpoint. Format: `projects/{project}/global/networks/{network}`", "type": "string" }, "pscForwardingRule": { @@ -6112,7 +6223,7 @@ "type": "string" }, "subnetwork": { -"description": "The name of the subnetwork from which the IP address will be allocated. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}`", +"description": "Optional. The name of the subnetwork from which the IP address will be allocated. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}`", "type": "string" }, "targetGoogleApi": { @@ -7246,8 +7357,11 @@ }, "advertisedRoutes": { "description": "Optional. [Preview only] List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported.", +"items": { "type": "string" }, +"type": "array" +}, "bandwidth": { "description": "Required. Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json index efeb4254ca..7f02dcc49b 100644 --- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json @@ -836,6 +836,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1alpha1/{+name}/operations", @@ -1122,7 +1127,7 @@ } } }, -"revision": "20250910", +"revision": "20250925", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AllocationOptions": { @@ -1274,6 +1279,13 @@ "$ref": "GoogleLongrunningOperation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index db860d5eb5..7e10e323cc 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -294,6 +294,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -950,331 +955,16 @@ "description": "The standard list page token.", "location": "query", "type": "string" -} -}, -"path": "v1/{+name}/operations", -"response": { -"$ref": "ListOperationsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -} -} -}, -"networkMonitoringProviders": { -"methods": { -"create": { -"description": "Creates a NetworkMonitoringProvider resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders", -"httpMethod": "POST", -"id": "networkmanagement.projects.locations.networkMonitoringProviders.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"networkMonitoringProviderId": { -"description": "Required. The ID to use for the NetworkMonitoringProvider resource, which will become the final component of the NetworkMonitoringProvider resource's name.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. Parent value for CreateNetworkMonitoringProviderRequest. Format: projects/{project}/locations/{location}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/networkMonitoringProviders", -"request": { -"$ref": "NetworkMonitoringProvider" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Deletes a NetworkMonitoringProvider resource and all of its child resources.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}", -"httpMethod": "DELETE", -"id": "networkmanagement.projects.locations.networkMonitoringProviders.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Gets the NetworkMonitoringProvider resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}", -"httpMethod": "GET", -"id": "networkmanagement.projects.locations.networkMonitoringProviders.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. Name of the resource. Format: `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "NetworkMonitoringProvider" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists NetworkMonitoringProviders for a given project and location.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders", -"httpMethod": "GET", -"id": "networkmanagement.projects.locations.networkMonitoringProviders.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"pageSize": { -"description": "Optional. The maximum number of monitoring points to return. The service may return fewer than this value. If unspecified, at most 20 monitoring points will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A page token, received from a previous `ListMonitoringPoints` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMonitoringPoints` must match the call that provided the page token.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. Parent value for ListNetworkMonitoringProvidersRequest. Format: `projects/{project}/locations/{location}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/networkMonitoringProviders", -"response": { -"$ref": "ListNetworkMonitoringProvidersResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -}, -"resources": { -"monitoringPoints": { -"methods": { -"get": { -"description": "Gets the MonitoringPoint resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/monitoringPoints/{monitoringPointsId}", -"httpMethod": "GET", -"id": "networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+/monitoringPoints/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "MonitoringPoint" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists MonitoringPoints for a given network monitoring provider.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/monitoringPoints", -"httpMethod": "GET", -"id": "networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"pageSize": { -"description": "Optional. The maximum number of monitoring points to return. The service may return fewer than this value. If unspecified, at most 20 monitoring points will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A page token, received from a previous `ListMonitoringPoints` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMonitoringPoints` must match the call that provided the page token.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. Parent value for ListMonitoringPointsRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/monitoringPoints", -"response": { -"$ref": "ListMonitoringPointsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, -"networkPaths": { -"methods": { -"get": { -"description": "Gets the NetworkPath resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/networkPaths/{networkPathsId}", -"httpMethod": "GET", -"id": "networkmanagement.projects.locations.networkMonitoringProviders.networkPaths.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/networkPaths/{network_path}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+/networkPaths/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "NetworkPath" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists NetworkPaths for a given network monitoring provider.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/networkPaths", -"httpMethod": "GET", -"id": "networkmanagement.projects.locations.networkMonitoringProviders.networkPaths.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"pageSize": { -"description": "Optional. The maximum number of network paths to return. The service may return fewer than this value. If unspecified, at most 20 network pathswill be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A page token, received from a previous `ListNetworkPaths` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListNetworkPaths` must match the call that provided the page token.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. Parent value for ListNetworkPathsRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/networkPaths", -"response": { -"$ref": "ListNetworkPathsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, -"webPaths": { -"methods": { -"get": { -"description": "Gets the WebPath resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/webPaths/{webPathsId}", -"httpMethod": "GET", -"id": "networkmanagement.projects.locations.networkMonitoringProviders.webPaths.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. Name of the resource.. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/webPaths/{web_path}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+/webPaths/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "WebPath" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists WebPaths for a given network monitoring provider.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/webPaths", -"httpMethod": "GET", -"id": "networkmanagement.projects.locations.networkMonitoringProviders.webPaths.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"pageSize": { -"description": "Optional. The maximum number of web paths to return. The service may return fewer than this value. If unspecified, at most 20 web paths will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", -"format": "int32", -"location": "query", -"type": "integer" }, -"pageToken": { -"description": "Optional. A page token, received from a previous `ListWebPaths` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWebPaths` must match the call that provided the page token.", +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", -"type": "string" -}, -"parent": { -"description": "Required. Parent value for ListWebPathsRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+$", -"required": true, -"type": "string" +"type": "boolean" } }, -"path": "v1/{+parent}/webPaths", +"path": "v1/{+name}/operations", "response": { -"$ref": "ListWebPathsResponse" +"$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -1543,7 +1233,7 @@ } } }, -"revision": "20250905", +"revision": "20250925", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -2920,24 +2610,9 @@ false }, "type": "object" }, -"GeoLocation": { -"description": "The geographical location of the MonitoringPoint.", -"id": "GeoLocation", -"properties": { -"country": { -"description": "Country.", -"type": "string" -}, -"formattedAddress": { -"description": "Formatted address.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleServiceInfo": { -"description": "For display only. Details of a Google Service sending packets to a VPC network. Although the source IP might be a publicly routable address, some Google Services use special routes within Google production infrastructure to reach Compute Engine Instances. https://cloud.google.com/vpc/docs/routes#special_return_paths", -"id": "GoogleServiceInfo", +"GoogleServiceInfo": { +"description": "For display only. Details of a Google Service sending packets to a VPC network. Although the source IP might be a publicly routable address, some Google Services use special routes within Google production infrastructure to reach Compute Engine Instances. https://cloud.google.com/vpc/docs/routes#special_return_paths", +"id": "GoogleServiceInfo", "properties": { "googleServiceType": { "description": "Recognized type of a Google Service.", @@ -2970,56 +2645,6 @@ false }, "type": "object" }, -"Host": { -"description": "Message describing information about the host.", -"id": "Host", -"properties": { -"cloudInstanceId": { -"description": "Output only. The cloud instance id of the host.", -"readOnly": true, -"type": "string" -}, -"cloudProjectId": { -"description": "Output only. The cloud project id of the host.", -"readOnly": true, -"type": "string" -}, -"cloudProvider": { -"description": "Output only. The cloud provider of the host.", -"readOnly": true, -"type": "string" -}, -"cloudRegion": { -"description": "Output only. The cloud region of the host.", -"readOnly": true, -"type": "string" -}, -"cloudVirtualNetworkIds": { -"description": "Output only. The ids of cloud virtual networks of the host.", -"items": { -"type": "string" -}, -"readOnly": true, -"type": "array" -}, -"cloudVpcId": { -"description": "Output only. The id of Virtual Private Cloud (VPC) of the host.", -"readOnly": true, -"type": "string" -}, -"cloudZone": { -"description": "Output only. The cloud zone of the host.", -"readOnly": true, -"type": "string" -}, -"os": { -"description": "Output only. The operating system of the host.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "HybridSubnetInfo": { "description": "For display only. Metadata associated with a hybrid subnet.", "id": "HybridSubnetInfo", @@ -3228,60 +2853,6 @@ false }, "type": "object" }, -"ListMonitoringPointsResponse": { -"description": "Message for response to listing MonitoringPoints", -"id": "ListMonitoringPointsResponse", -"properties": { -"monitoringPoints": { -"description": "The list of MonitoringPoints.", -"items": { -"$ref": "MonitoringPoint" -}, -"type": "array" -}, -"nextPageToken": { -"description": "A token identifying a page of results the server should return.", -"type": "string" -} -}, -"type": "object" -}, -"ListNetworkMonitoringProvidersResponse": { -"description": "Message for response to listing NetworkMonitoringProviders", -"id": "ListNetworkMonitoringProvidersResponse", -"properties": { -"networkMonitoringProviders": { -"description": "The list of NetworkMonitoringProvider", -"items": { -"$ref": "NetworkMonitoringProvider" -}, -"type": "array" -}, -"nextPageToken": { -"description": "A token identifying a page of results the server should return.", -"type": "string" -} -}, -"type": "object" -}, -"ListNetworkPathsResponse": { -"description": "Message for response to listing NetworkPaths", -"id": "ListNetworkPathsResponse", -"properties": { -"networkPaths": { -"description": "The list of NetworkPath", -"items": { -"$ref": "NetworkPath" -}, -"type": "array" -}, -"nextPageToken": { -"description": "A token identifying a page of results the server should return.", -"type": "string" -} -}, -"type": "object" -}, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "ListOperationsResponse", @@ -3296,6 +2867,13 @@ false "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -3325,24 +2903,6 @@ false }, "type": "object" }, -"ListWebPathsResponse": { -"description": "Message for response to listing WebPaths", -"id": "ListWebPathsResponse", -"properties": { -"nextPageToken": { -"description": "A token identifying a page of results the server should return.", -"type": "string" -}, -"webPaths": { -"description": "The list of WebPath.", -"items": { -"$ref": "WebPath" -}, -"type": "array" -} -}, -"type": "object" -}, "LoadBalancerBackend": { "description": "For display only. Metadata associated with a specific load balancer backend.", "id": "LoadBalancerBackend", @@ -3541,146 +3101,6 @@ false }, "type": "object" }, -"MonitoringPoint": { -"description": "Message describing MonitoringPoint resource.", -"id": "MonitoringPoint", -"properties": { -"autoGeoLocationEnabled": { -"description": "Output only. Indicates if automaitic geographic location is enabled for the MonitoringPoint.", -"readOnly": true, -"type": "boolean" -}, -"connectionStatus": { -"description": "Output only. Connection status of the MonitoringPoint.", -"enum": [ -"CONNECTION_STATUS_UNSPECIFIED", -"ONLINE", -"OFFLINE" -], -"enumDescriptions": [ -"The default value. This value is used if the status is omitted.", -"MonitoringPoint is online.", -"MonitoringPoint is offline." -], -"readOnly": true, -"type": "string" -}, -"createTime": { -"description": "Output only. The time the MonitoringPoint was created.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"displayName": { -"description": "Output only. Display name of the MonitoringPoint.", -"readOnly": true, -"type": "string" -}, -"errors": { -"description": "Output only. The codes of errors detected in the MonitoringPoint.", -"items": { -"enum": [ -"ERROR_CODE_UNSPECIFIED", -"NTP_ERROR", -"UPGRADE_ERROR", -"DOWNLOAD_FAILED" -], -"enumDescriptions": [ -"The default value. This value is used if the error code is omitted.", -"Error detected in NTP service.", -"Error detected during the upgrade process.", -"Error detected while downloading." -], -"type": "string" -}, -"readOnly": true, -"type": "array" -}, -"geoLocation": { -"$ref": "GeoLocation", -"description": "Output only. The geographical location of the MonitoringPoint. ;", -"readOnly": true -}, -"host": { -"$ref": "Host", -"description": "Output only. The host information of the MonitoringPoint.", -"readOnly": true -}, -"hostname": { -"description": "Output only. The hostname of the MonitoringPoint.", -"readOnly": true, -"type": "string" -}, -"name": { -"description": "Identifier. Name of the resource. Format: `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point}`", -"type": "string" -}, -"networkInterfaces": { -"description": "Output only. The network interfaces of the MonitoringPoint.", -"items": { -"$ref": "NetworkInterface" -}, -"readOnly": true, -"type": "array" -}, -"originatingIp": { -"description": "Output only. IP address visible when MonitoringPoint connects to the provider.", -"readOnly": true, -"type": "string" -}, -"providerTags": { -"description": "Output only. The provider tags of the MonitoringPoint.", -"items": { -"$ref": "ProviderTag" -}, -"readOnly": true, -"type": "array" -}, -"type": { -"description": "Output only. Deployment type of the MonitoringPoint.", -"readOnly": true, -"type": "string" -}, -"updateTime": { -"description": "Output only. The time the MonitoringPoint was updated.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"upgradeAvailable": { -"description": "Output only. Indicates if an upgrade is available for the MonitoringPoint.", -"readOnly": true, -"type": "boolean" -}, -"upgradeType": { -"description": "Output only. The type of upgrade available for the MonitoringPoint.", -"enum": [ -"UPGRADE_TYPE_UNSPECIFIED", -"MANUAL", -"MANAGED", -"SCHEDULED", -"AUTO", -"EXTERNAL" -], -"enumDescriptions": [ -"The default value. This value is used if the upgrade type is omitted.", -"Upgrades are performed manually.", -"Upgrades are managed.", -"Upgrade is scheduled.", -"Upgrades are performed automatically.", -"Upgrades are performed externally." -], -"readOnly": true, -"type": "string" -}, -"version": { -"description": "Output only. Version of the software running on the MonitoringPoint.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "NatInfo": { "description": "For display only. Metadata associated with NAT.", "id": "NatInfo", @@ -3787,234 +3207,6 @@ false }, "type": "object" }, -"NetworkInterface": { -"description": "Message describing network interfaces.", -"id": "NetworkInterface", -"properties": { -"adapterDescription": { -"description": "Output only. The description of the interface.", -"readOnly": true, -"type": "string" -}, -"cidr": { -"description": "Output only. The IP address of the interface and subnet mask in CIDR format. Examples: 192.168.1.0/24, 2001:db8::/32", -"readOnly": true, -"type": "string" -}, -"interfaceName": { -"description": "Output only. The name of the network interface. Examples: eth0, eno1", -"readOnly": true, -"type": "string" -}, -"ipAddress": { -"description": "Output only. The IP address of the interface.", -"readOnly": true, -"type": "string" -}, -"macAddress": { -"description": "Output only. The MAC address of the interface.", -"readOnly": true, -"type": "string" -}, -"speed": { -"description": "Output only. Speed of the interface in millions of bits per second.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"vlanId": { -"description": "Output only. The id of the VLAN.", -"format": "int64", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"NetworkMonitoringProvider": { -"description": "Message describing NetworkMonitoringProvider resource.", -"id": "NetworkMonitoringProvider", -"properties": { -"createTime": { -"description": "Output only. The time the NetworkMonitoringProvider was created.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"errors": { -"description": "Output only. The list of error messages detected for the NetworkMonitoringProvider.", -"items": { -"type": "string" -}, -"readOnly": true, -"type": "array" -}, -"name": { -"description": "Output only. Identifier. Name of the resource. Format: `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}`", -"readOnly": true, -"type": "string" -}, -"providerType": { -"description": "Required. Type of the NetworkMonitoringProvider.", -"enum": [ -"PROVIDER_TYPE_UNSPECIFIED", -"EXTERNAL" -], -"enumDescriptions": [ -"The default value. This value is used if the type is omitted.", -"External provider." -], -"type": "string" -}, -"providerUri": { -"description": "Output only. Link to the provider's UI.", -"readOnly": true, -"type": "string" -}, -"state": { -"description": "Output only. State of the NetworkMonitoringProvider.", -"enum": [ -"STATE_UNSPECIFIED", -"ACTIVATING", -"ACTIVE", -"SUSPENDING", -"SUSPENDED", -"DELETING", -"DELETED" -], -"enumDescriptions": [ -"The default value. This value is used if the status is omitted.", -"NetworkMonitoringProvider is being activated.", -"NetworkMonitoringProvider is active.", -"NetworkMonitoringProvider is being suspended.", -"NetworkMonitoringProvider is suspended.", -"NetworkMonitoringProvider is being deleted.", -"NetworkMonitoringProvider is deleted." -], -"readOnly": true, -"type": "string" -}, -"updateTime": { -"description": "Output only. The time the NetworkMonitoringProvider was updated.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"NetworkPath": { -"description": "Message describing NetworkPath resource.", -"id": "NetworkPath", -"properties": { -"createTime": { -"description": "Output only. The time the NetworkPath was created.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"destination": { -"description": "Output only. IP address or hostname of the network path destination.", -"readOnly": true, -"type": "string" -}, -"destinationGeoLocation": { -"$ref": "GeoLocation", -"description": "Output only. Geographical location of the destination MonitoringPoint. ;", -"readOnly": true -}, -"displayName": { -"description": "Output only. The display name of the network path.", -"readOnly": true, -"type": "string" -}, -"dualEnded": { -"description": "Output only. Indicates if the network path is dual ended. When true, the network path is measured both: from both source to destination, and from destination to source. When false, the network path is measured from the source through the destination back to the source (round trip measurement).", -"readOnly": true, -"type": "boolean" -}, -"monitoringEnabled": { -"description": "Output only. Is monitoring enabled for the network path.", -"readOnly": true, -"type": "boolean" -}, -"monitoringPolicyDisplayName": { -"description": "Output only. Display name of the monitoring policy.", -"readOnly": true, -"type": "string" -}, -"monitoringPolicyId": { -"description": "Output only. ID of monitoring policy.", -"readOnly": true, -"type": "string" -}, -"monitoringStatus": { -"description": "Output only. The monitoring status of the network path.", -"enum": [ -"MONITORING_STATUS_UNSPECIFIED", -"MONITORING", -"POLICY_MISMATCH", -"MONITORING_POINT_OFFLINE", -"DISABLED" -], -"enumDescriptions": [ -"The default value. This value is used if the status is omitted.", -"Monitoring is enabled.", -"Policy is mismatched.", -"Monitoring point is offline.", -"Monitoring is disabled." -], -"readOnly": true, -"type": "string" -}, -"name": { -"description": "Identifier. Name of the resource. Format: `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/networkPaths/{network_path}`", -"type": "string" -}, -"networkProtocol": { -"description": "Output only. The network protocol of the network path.", -"enum": [ -"NETWORK_PROTOCOL_UNSPECIFIED", -"ICMP", -"UDP", -"TCP" -], -"enumDescriptions": [ -"The default value. This value is used if the network protocol is omitted.", -"ICMP.", -"UDP.", -"TCP." -], -"readOnly": true, -"type": "string" -}, -"providerTags": { -"description": "Output only. The provider tags of the network path.", -"items": { -"$ref": "ProviderTag" -}, -"readOnly": true, -"type": "array" -}, -"providerUiUri": { -"description": "Output only. Link to provider's UI; link shows the NetworkPath.", -"readOnly": true, -"type": "string" -}, -"sourceMonitoringPointId": { -"description": "Output only. Provider's UUID of the source MonitoringPoint. This id may not point to a resource in the GCP.", -"readOnly": true, -"type": "string" -}, -"updateTime": { -"description": "Output only. The time the NetworkPath was updated.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -4199,42 +3391,6 @@ false }, "type": "object" }, -"ProviderTag": { -"description": "Message describing the provider tag.", -"id": "ProviderTag", -"properties": { -"category": { -"description": "Output only. The category of the provider tag.", -"readOnly": true, -"type": "string" -}, -"resourceType": { -"description": "Output only. The resource type of the provider tag.", -"enum": [ -"RESOURCE_TYPE_UNSPECIFIED", -"NETWORK_PATH", -"WEB_PATH", -"MONITORING_POLICY", -"MONITORING_POINT" -], -"enumDescriptions": [ -"The default value. This value is used if the status is omitted.", -"Network path.", -"Web path.", -"Monitoring policy.", -"Monitoring point." -], -"readOnly": true, -"type": "string" -}, -"value": { -"description": "Output only. The value of the provider tag.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "ProxyConnectionInfo": { "description": "For display only. Metadata associated with ProxyConnection.", "id": "ProxyConnectionInfo", @@ -5325,117 +4481,6 @@ false } }, "type": "object" -}, -"WebPath": { -"description": "Message describing WebPath resource.", -"id": "WebPath", -"properties": { -"createTime": { -"description": "Output only. The time the WebPath was created.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"destination": { -"description": "Output only. Web monitoring target.", -"readOnly": true, -"type": "string" -}, -"displayName": { -"description": "Output only. Display name of the WebPath.", -"readOnly": true, -"type": "string" -}, -"interval": { -"description": "Output only. Monitoring interval.", -"format": "google-duration", -"readOnly": true, -"type": "string" -}, -"monitoringEnabled": { -"description": "Output only. Is monitoring enabled for the WebPath.", -"readOnly": true, -"type": "boolean" -}, -"monitoringPolicyDisplayName": { -"description": "Output only. Display name of the monitoring policy.", -"readOnly": true, -"type": "string" -}, -"monitoringPolicyId": { -"description": "Output only. ID of the monitoring policy.", -"readOnly": true, -"type": "string" -}, -"monitoringStatus": { -"description": "Output only. The monitoring status of the WebPath.", -"enum": [ -"MONITORING_STATUS_UNSPECIFIED", -"MONITORING", -"POLICY_MISMATCH", -"MONITORING_POINT_OFFLINE", -"DISABLED" -], -"enumDescriptions": [ -"The default value. This value is used if the status is omitted.", -"Monitoring is enabled.", -"Policy is mismatched.", -"Monitoring point is offline.", -"Monitoring is disabled." -], -"readOnly": true, -"type": "string" -}, -"name": { -"description": "Identifier. Name of the resource. Format: `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/webPaths/{web_path}`", -"type": "string" -}, -"providerTags": { -"description": "Output only. The provider tags of the web path.", -"items": { -"$ref": "ProviderTag" -}, -"readOnly": true, -"type": "array" -}, -"providerUiUri": { -"description": "Output only. Link to provider's UI; link shows the WebPath.", -"readOnly": true, -"type": "string" -}, -"relatedNetworkPathId": { -"description": "Output only. Provider's UUID of the related NetworkPath.", -"readOnly": true, -"type": "string" -}, -"sourceMonitoringPointId": { -"description": "Output only. ID of the source MonitoringPoint.", -"readOnly": true, -"type": "string" -}, -"updateTime": { -"description": "Output only. The time the WebPath was updated.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"workflowType": { -"description": "Output only. The workflow type of the WebPath.", -"enum": [ -"WORKFLOW_TYPE_UNSPECIFIED", -"BROWSER", -"HTTP" -], -"enumDescriptions": [ -"The default value. This value is used if the status is omitted.", -"Browser.", -"HTTP." -], -"readOnly": true, -"type": "string" -} -}, -"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index bce8d83c97..e8d6584c38 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -296,6 +296,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -954,6 +959,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -1227,7 +1237,7 @@ } } }, -"revision": "20250905", +"revision": "20250925", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -2869,6 +2879,13 @@ false "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1.json index eac903a216..2679dfff88 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1.json @@ -699,6 +699,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -4485,6 +4490,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -5070,7 +5080,7 @@ } } }, -"revision": "20250911", +"revision": "20250925", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -5632,7 +5642,7 @@ "id": "AuthzPolicyTarget", "properties": { "loadBalancingScheme": { -"description": "Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `INTERNAL_SELF_MANAGED`, and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).", +"description": "Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).", "enum": [ "LOAD_BALANCING_SCHEME_UNSPECIFIED", "INTERNAL_MANAGED", @@ -5648,7 +5658,7 @@ "type": "string" }, "resources": { -"description": "Required. A list of references to the Forwarding Rules on which this policy will be applied. For policies created for Cloudrun, this field will reference the Cloud Run services.", +"description": "Required. A list of references to the Forwarding Rules on which this policy will be applied.", "items": { "type": "string" }, @@ -7263,6 +7273,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json index 1893c0a47b..2356f4bd32 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json @@ -699,6 +699,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -4642,6 +4647,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -5513,7 +5523,7 @@ } } }, -"revision": "20250911", +"revision": "20250925", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -6075,7 +6085,7 @@ "id": "AuthzPolicyTarget", "properties": { "loadBalancingScheme": { -"description": "Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `INTERNAL_SELF_MANAGED`, and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).", +"description": "Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).", "enum": [ "LOAD_BALANCING_SCHEME_UNSPECIFIED", "INTERNAL_MANAGED", @@ -6091,7 +6101,7 @@ "type": "string" }, "resources": { -"description": "Required. A list of references to the Forwarding Rules on which this policy will be applied. For policies created for Cloudrun, this field will reference the Cloud Run services.", +"description": "Required. A list of references to the Forwarding Rules on which this policy will be applied.", "items": { "type": "string" }, @@ -7780,6 +7790,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/observability.v1.json b/googleapiclient/discovery_cache/documents/observability.v1.json index bcf62e3e70..176183f57d 100644 --- a/googleapiclient/discovery_cache/documents/observability.v1.json +++ b/googleapiclient/discovery_cache/documents/observability.v1.json @@ -294,6 +294,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -531,7 +536,7 @@ } } }, -"revision": "20250904", +"revision": "20250925", "rootUrl": "https://observability.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -578,6 +583,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json index 70901286b9..6bb438d243 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json @@ -217,6 +217,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -339,7 +344,7 @@ } } }, -"revision": "20250815", +"revision": "20250929", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -1748,6 +1753,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json index 321dead1de..173a676278 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json @@ -217,6 +217,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -339,7 +344,7 @@ } } }, -"revision": "20250815", +"revision": "20250929", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -1743,6 +1748,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/osconfig.v2.json b/googleapiclient/discovery_cache/documents/osconfig.v2.json index ac08bb3750..b655e725bb 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v2.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v2.json @@ -406,6 +406,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2/{+name}/operations", @@ -723,6 +728,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2/{+name}/operations", @@ -1040,6 +1050,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2/{+name}/operations", @@ -1057,7 +1072,7 @@ } } }, -"revision": "20250511", +"revision": "20250928", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -1500,6 +1515,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/osconfig.v2beta.json b/googleapiclient/discovery_cache/documents/osconfig.v2beta.json index a990a6d68f..a42c953719 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v2beta.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v2beta.json @@ -406,6 +406,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2beta/{+name}/operations", @@ -723,6 +728,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2beta/{+name}/operations", @@ -1040,6 +1050,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2beta/{+name}/operations", @@ -1057,7 +1072,7 @@ } } }, -"revision": "20250511", +"revision": "20250928", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -1500,6 +1515,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/parallelstore.v1.json b/googleapiclient/discovery_cache/documents/parallelstore.v1.json index 2d1ed7a31f..e702dcc19f 100644 --- a/googleapiclient/discovery_cache/documents/parallelstore.v1.json +++ b/googleapiclient/discovery_cache/documents/parallelstore.v1.json @@ -532,6 +532,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -549,7 +554,7 @@ } } }, -"revision": "20250908", +"revision": "20250924", "rootUrl": "https://parallelstore.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -832,6 +837,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/parallelstore.v1beta.json b/googleapiclient/discovery_cache/documents/parallelstore.v1beta.json index e5c782075b..36bfd9e0c4 100644 --- a/googleapiclient/discovery_cache/documents/parallelstore.v1beta.json +++ b/googleapiclient/discovery_cache/documents/parallelstore.v1beta.json @@ -529,6 +529,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -546,7 +551,7 @@ } } }, -"revision": "20250908", +"revision": "20250924", "rootUrl": "https://parallelstore.googleapis.com/", "schemas": { "DestinationGcsBucket": { @@ -823,6 +828,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json index 72ac0f7648..7fdaca5600 100644 --- a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +++ b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json @@ -523,7 +523,7 @@ } } }, -"revision": "20250814", +"revision": "20250929", "rootUrl": "https://paymentsresellersubscription.googleapis.com/", "schemas": { "Amount": { @@ -563,6 +563,7 @@ "CANCELLATION_REASON_USER_DELINQUENCY", "CANCELLATION_REASON_SYSTEM_ERROR", "CANCELLATION_REASON_SYSTEM_CANCEL", +"CANCELLATION_REASON_BILLING_SYSTEM_SWITCH", "CANCELLATION_REASON_OTHER" ], "enumDescriptions": [ @@ -576,6 +577,7 @@ "Cancellation due to user delinquency", "Used for notification only, do not use in Cancel API. Cancellation due to an unrecoverable system error.", "Used for notification only, do not use in Cancel API. The subscription is cancelled by Google automatically since it is no longer valid.", +"Cancellation due to a billing system switch.", "Other reason." ], "type": "string" @@ -1423,6 +1425,7 @@ "CANCELLATION_REASON_USER_DELINQUENCY", "CANCELLATION_REASON_SYSTEM_ERROR", "CANCELLATION_REASON_SYSTEM_CANCEL", +"CANCELLATION_REASON_BILLING_SYSTEM_SWITCH", "CANCELLATION_REASON_OTHER" ], "enumDescriptions": [ @@ -1436,6 +1439,7 @@ "Cancellation due to user delinquency", "Used for notification only, do not use in Cancel API. Cancellation due to an unrecoverable system error.", "Used for notification only, do not use in Cancel API. The subscription is cancelled by Google automatically since it is no longer valid.", +"Cancellation due to a billing system switch.", "Other reason." ], "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/privateca.v1.json b/googleapiclient/discovery_cache/documents/privateca.v1.json index 7adc26b294..7850badcb3 100644 --- a/googleapiclient/discovery_cache/documents/privateca.v1.json +++ b/googleapiclient/discovery_cache/documents/privateca.v1.json @@ -1594,6 +1594,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1611,7 +1616,7 @@ } } }, -"revision": "20250910", +"revision": "20250926", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AccessUrls": { @@ -2854,6 +2859,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/privateca.v1beta1.json b/googleapiclient/discovery_cache/documents/privateca.v1beta1.json index 9340fbb37e..ef3bda9eb1 100644 --- a/googleapiclient/discovery_cache/documents/privateca.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/privateca.v1beta1.json @@ -478,6 +478,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -586,7 +591,7 @@ } } }, -"revision": "20250910", +"revision": "20250926", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AuditConfig": { @@ -726,6 +731,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json index 4729f04f8b..87446c8c2f 100644 --- a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json @@ -786,7 +786,7 @@ } } }, -"revision": "20250917", +"revision": "20250928", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -1942,7 +1942,7 @@ true "id": "GoogleCloudRecaptchaenterpriseV1RiskAnalysis", "properties": { "challenge": { -"description": "Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE keys", +"description": "Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE keys.", "enum": [ "CHALLENGE_UNSPECIFIED", "NOCAPTCHA", diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index 89fb289b7a..9404441672 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -1073,7 +1073,7 @@ } } }, -"revision": "20250909", +"revision": "20250930", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1608,6 +1608,10 @@ "description": "Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.", "readOnly": true }, +"maintenanceVersion": { +"description": "Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field.", +"type": "string" +}, "managedBackupSource": { "$ref": "ManagedBackupSource", "description": "Optional. Backups generated and managed by memorystore service." @@ -2303,7 +2307,8 @@ "SIGNAL_TYPE_MANY_IDLE_CONNECTIONS", "SIGNAL_TYPE_REPLICATION_LAG", "SIGNAL_TYPE_OUTDATED_VERSION", -"SIGNAL_TYPE_OUTDATED_CLIENT" +"SIGNAL_TYPE_OUTDATED_CLIENT", +"SIGNAL_TYPE_DATABOOST_DISABLED" ], "enumDeprecated": [ false, @@ -2407,6 +2412,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -2511,7 +2517,8 @@ false "High number of idle connections.", "Replication delay.", "Outdated version.", -"Outdated client." +"Outdated client.", +"Databoost is disabled." ], "type": "string" }, @@ -2575,7 +2582,7 @@ false "type": "object" }, "DatabaseResourceMetadata": { -"description": "Common model for database resource instance metadata. Next ID: 27", +"description": "Common model for database resource instance metadata. Next ID: 29", "id": "DatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -2726,6 +2733,10 @@ false "$ref": "MachineConfiguration", "description": "Machine configuration for this resource." }, +"maintenanceInfo": { +"$ref": "ResourceMaintenanceInfo", +"description": "Optional. Maintenance info for the resource." +}, "primaryResourceId": { "$ref": "DatabaseResourceId", "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." @@ -2945,7 +2956,8 @@ false "SIGNAL_TYPE_MANY_IDLE_CONNECTIONS", "SIGNAL_TYPE_REPLICATION_LAG", "SIGNAL_TYPE_OUTDATED_VERSION", -"SIGNAL_TYPE_OUTDATED_CLIENT" +"SIGNAL_TYPE_OUTDATED_CLIENT", +"SIGNAL_TYPE_DATABOOST_DISABLED" ], "enumDeprecated": [ false, @@ -3049,6 +3061,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -3153,7 +3166,8 @@ false "High number of idle connections.", "Replication delay.", "Outdated version.", -"Outdated client." +"Outdated client.", +"Databoost is disabled." ], "type": "string" } @@ -3221,6 +3235,28 @@ false }, "type": "object" }, +"Date": { +"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", +"id": "Date", +"properties": { +"day": { +"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", +"format": "int32", +"type": "integer" +}, +"month": { +"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", +"format": "int32", +"type": "integer" +}, +"year": { +"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "DiscoveryEndpoint": { "description": "Endpoints on each network, for Redis clients to connect to the cluster.", "id": "DiscoveryEndpoint", @@ -4495,6 +4531,7 @@ false "PRODUCT_TYPE_FIRESTORE", "PRODUCT_TYPE_COMPUTE_ENGINE", "PRODUCT_TYPE_ORACLE_ON_GCP", +"PRODUCT_TYPE_BIGQUERY", "PRODUCT_TYPE_OTHER" ], "enumDeprecated": [ @@ -4511,6 +4548,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -4527,6 +4565,7 @@ false "Firestore product area in GCP.", "Compute Engine self managed databases", "Oracle product area in GCP", +"BigQuery product area in GCP", "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum." ], "type": "string" @@ -4845,6 +4884,100 @@ false }, "type": "object" }, +"ResourceMaintenanceDenySchedule": { +"description": "Deny maintenance period for the database resource. It specifies the time range during which the maintenance cannot start. This is configured by the customer.", +"id": "ResourceMaintenanceDenySchedule", +"properties": { +"endDate": { +"$ref": "Date", +"description": "Optional. Deny period end date." +}, +"startDate": { +"$ref": "Date", +"description": "Optional. The start date of the deny maintenance period." +}, +"time": { +"$ref": "TimeOfDay", +"description": "Optional. Time in UTC when the deny period starts on start_date and ends on end_date." +} +}, +"type": "object" +}, +"ResourceMaintenanceInfo": { +"description": "MaintenanceInfo to capture the maintenance details of database resource.", +"id": "ResourceMaintenanceInfo", +"properties": { +"denyMaintenanceSchedules": { +"description": "Optional. List of Deny maintenance period for the database resource.", +"items": { +"$ref": "ResourceMaintenanceDenySchedule" +}, +"type": "array" +}, +"maintenanceSchedule": { +"$ref": "ResourceMaintenanceSchedule", +"description": "Optional. Maintenance window for the database resource." +}, +"maintenanceVersion": { +"description": "Optional. Current Maintenance version of the database resource. Example: \"MYSQL_8_0_41.R20250531.01_15\"", +"type": "string" +} +}, +"type": "object" +}, +"ResourceMaintenanceSchedule": { +"description": "Maintenance window for the database resource. It specifies preferred time and day of the week and phase in some cases, when the maintenance can start. This is configured by the customer.", +"id": "ResourceMaintenanceSchedule", +"properties": { +"day": { +"description": "Optional. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.", +"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" +}, +"phase": { +"description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance", +"enum": [ +"WINDOW_PHASE_UNSPECIFIED", +"WINDOW_PHASE_ANY", +"WINDOW_PHASE_WEEK1", +"WINDOW_PHASE_WEEK2", +"WINDOW_PHASE_WEEK5" +], +"enumDescriptions": [ +"Phase is unspecified.", +"Any phase.", +"Week 1.", +"Week 2.", +"Week 5." +], +"type": "string" +}, +"time": { +"$ref": "TimeOfDay", +"description": "Optional. Preferred time to start the maintenance operation on the specified day." +} +}, +"type": "object" +}, "RetentionSettings": { "id": "RetentionSettings", "properties": { diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index d53575e626..fad5adad44 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -1073,7 +1073,7 @@ } } }, -"revision": "20250909", +"revision": "20250930", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1608,6 +1608,10 @@ "description": "Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.", "readOnly": true }, +"maintenanceVersion": { +"description": "Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field.", +"type": "string" +}, "managedBackupSource": { "$ref": "ManagedBackupSource", "description": "Optional. Backups generated and managed by memorystore service." @@ -2303,7 +2307,8 @@ "SIGNAL_TYPE_MANY_IDLE_CONNECTIONS", "SIGNAL_TYPE_REPLICATION_LAG", "SIGNAL_TYPE_OUTDATED_VERSION", -"SIGNAL_TYPE_OUTDATED_CLIENT" +"SIGNAL_TYPE_OUTDATED_CLIENT", +"SIGNAL_TYPE_DATABOOST_DISABLED" ], "enumDeprecated": [ false, @@ -2407,6 +2412,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -2511,7 +2517,8 @@ false "High number of idle connections.", "Replication delay.", "Outdated version.", -"Outdated client." +"Outdated client.", +"Databoost is disabled." ], "type": "string" }, @@ -2575,7 +2582,7 @@ false "type": "object" }, "DatabaseResourceMetadata": { -"description": "Common model for database resource instance metadata. Next ID: 27", +"description": "Common model for database resource instance metadata. Next ID: 29", "id": "DatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -2726,6 +2733,10 @@ false "$ref": "MachineConfiguration", "description": "Machine configuration for this resource." }, +"maintenanceInfo": { +"$ref": "ResourceMaintenanceInfo", +"description": "Optional. Maintenance info for the resource." +}, "primaryResourceId": { "$ref": "DatabaseResourceId", "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." @@ -2945,7 +2956,8 @@ false "SIGNAL_TYPE_MANY_IDLE_CONNECTIONS", "SIGNAL_TYPE_REPLICATION_LAG", "SIGNAL_TYPE_OUTDATED_VERSION", -"SIGNAL_TYPE_OUTDATED_CLIENT" +"SIGNAL_TYPE_OUTDATED_CLIENT", +"SIGNAL_TYPE_DATABOOST_DISABLED" ], "enumDeprecated": [ false, @@ -3049,6 +3061,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -3153,7 +3166,8 @@ false "High number of idle connections.", "Replication delay.", "Outdated version.", -"Outdated client." +"Outdated client.", +"Databoost is disabled." ], "type": "string" } @@ -3221,6 +3235,28 @@ false }, "type": "object" }, +"Date": { +"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", +"id": "Date", +"properties": { +"day": { +"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", +"format": "int32", +"type": "integer" +}, +"month": { +"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", +"format": "int32", +"type": "integer" +}, +"year": { +"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "DiscoveryEndpoint": { "description": "Endpoints on each network, for Redis clients to connect to the cluster.", "id": "DiscoveryEndpoint", @@ -4502,6 +4538,7 @@ false "PRODUCT_TYPE_FIRESTORE", "PRODUCT_TYPE_COMPUTE_ENGINE", "PRODUCT_TYPE_ORACLE_ON_GCP", +"PRODUCT_TYPE_BIGQUERY", "PRODUCT_TYPE_OTHER" ], "enumDeprecated": [ @@ -4518,6 +4555,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -4534,6 +4572,7 @@ false "Firestore product area in GCP.", "Compute Engine self managed databases", "Oracle product area in GCP", +"BigQuery product area in GCP", "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum." ], "type": "string" @@ -4852,6 +4891,100 @@ false }, "type": "object" }, +"ResourceMaintenanceDenySchedule": { +"description": "Deny maintenance period for the database resource. It specifies the time range during which the maintenance cannot start. This is configured by the customer.", +"id": "ResourceMaintenanceDenySchedule", +"properties": { +"endDate": { +"$ref": "Date", +"description": "Optional. Deny period end date." +}, +"startDate": { +"$ref": "Date", +"description": "Optional. The start date of the deny maintenance period." +}, +"time": { +"$ref": "TimeOfDay", +"description": "Optional. Time in UTC when the deny period starts on start_date and ends on end_date." +} +}, +"type": "object" +}, +"ResourceMaintenanceInfo": { +"description": "MaintenanceInfo to capture the maintenance details of database resource.", +"id": "ResourceMaintenanceInfo", +"properties": { +"denyMaintenanceSchedules": { +"description": "Optional. List of Deny maintenance period for the database resource.", +"items": { +"$ref": "ResourceMaintenanceDenySchedule" +}, +"type": "array" +}, +"maintenanceSchedule": { +"$ref": "ResourceMaintenanceSchedule", +"description": "Optional. Maintenance window for the database resource." +}, +"maintenanceVersion": { +"description": "Optional. Current Maintenance version of the database resource. Example: \"MYSQL_8_0_41.R20250531.01_15\"", +"type": "string" +} +}, +"type": "object" +}, +"ResourceMaintenanceSchedule": { +"description": "Maintenance window for the database resource. It specifies preferred time and day of the week and phase in some cases, when the maintenance can start. This is configured by the customer.", +"id": "ResourceMaintenanceSchedule", +"properties": { +"day": { +"description": "Optional. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.", +"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" +}, +"phase": { +"description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance", +"enum": [ +"WINDOW_PHASE_UNSPECIFIED", +"WINDOW_PHASE_ANY", +"WINDOW_PHASE_WEEK1", +"WINDOW_PHASE_WEEK2", +"WINDOW_PHASE_WEEK5" +], +"enumDescriptions": [ +"Phase is unspecified.", +"Any phase.", +"Week 1.", +"Week 2.", +"Week 5." +], +"type": "string" +}, +"time": { +"$ref": "TimeOfDay", +"description": "Optional. Preferred time to start the maintenance operation on the specified day." +} +}, +"type": "object" +}, "RetentionSettings": { "id": "RetentionSettings", "properties": { diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index 7928c9cbb4..41143fa637 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -2253,6 +2253,11 @@ "description": "Token identifying which result to start with, which is returned by a previous list call.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -2902,7 +2907,7 @@ } } }, -"revision": "20250912", +"revision": "20250929", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -5203,6 +5208,13 @@ false "$ref": "GoogleLongrunningOperation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index 565922d71e..faca531a0b 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -1092,6 +1092,11 @@ "description": "Token identifying which result to start with, which is returned by a previous list call.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2/{+name}/operations", @@ -1319,7 +1324,7 @@ "type": "boolean" }, "name": { -"description": "The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id}", +"description": "Identifier. The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "required": true, @@ -1937,7 +1942,7 @@ } } }, -"revision": "20250905", +"revision": "20250929", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -3950,7 +3955,7 @@ "description": "Optional. Settings for multi-region deployment." }, "name": { -"description": "The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id}", +"description": "Identifier. The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id}", "type": "string" }, "observedGeneration": { @@ -4104,6 +4109,10 @@ "$ref": "GoogleCloudRunV2BuildpacksBuild", "description": "Build the source using Buildpacks." }, +"client": { +"description": "Optional. The client that initiated the build request.", +"type": "string" +}, "dockerBuild": { "$ref": "GoogleCloudRunV2DockerBuild", "description": "Build the source using Docker. This means the source has a Dockerfile." @@ -6561,6 +6570,13 @@ false "$ref": "GoogleLongrunningOperation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1.json index 3ac4fbd60a..3b298993de 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1.json @@ -63,6 +63,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://secretmanager.europe-north2.rep.googleapis.com/", "location": "europe-north2" }, @@ -133,6 +138,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-central1.rep.googleapis.com/", "location": "us-central1" }, @@ -1296,7 +1306,7 @@ } } }, -"revision": "20250910", +"revision": "20250926", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json index b2ced87ea3..7f4e982984 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json @@ -63,6 +63,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://secretmanager.europe-north2.rep.googleapis.com/", "location": "europe-north2" }, @@ -133,6 +138,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-central1.rep.googleapis.com/", "location": "us-central1" }, @@ -816,7 +826,7 @@ } } }, -"revision": "20250910", +"revision": "20250926", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json b/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json index d840f338b3..3e8c88335a 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json @@ -63,6 +63,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://secretmanager.europe-north2.rep.googleapis.com/", "location": "europe-north2" }, @@ -133,6 +138,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://secretmanager.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-central1.rep.googleapis.com/", "location": "us-central1" }, @@ -1296,7 +1306,7 @@ } } }, -"revision": "20250910", +"revision": "20250926", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json index faa0c4fd11..7ee934062d 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json @@ -222,6 +222,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}", @@ -1029,7 +1034,7 @@ } } }, -"revision": "20250722", +"revision": "20250929", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -2767,6 +2772,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/spanner.v1.json b/googleapiclient/discovery_cache/documents/spanner.v1.json index 46458c5570..5a32d75da1 100644 --- a/googleapiclient/discovery_cache/documents/spanner.v1.json +++ b/googleapiclient/discovery_cache/documents/spanner.v1.json @@ -1039,7 +1039,7 @@ "type": "string" }, "encryptionConfig.kmsKeyName": { -"description": "Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", +"description": "Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", "location": "query", "type": "string" }, @@ -1050,7 +1050,7 @@ "type": "string" }, "parent": { -"description": "Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form `projects//instances/`.", +"description": "Required. The name of the instance in which the backup is created. This must be the same instance that contains the database the backup is created from. The backup will be stored in the locations specified in the instance configuration of this instance. Values are of the form `projects//instances/`.", "location": "path", "pattern": "^projects/[^/]+/instances/[^/]+$", "required": true, @@ -1209,7 +1209,7 @@ "type": "string" }, "updateMask": { -"description": "Required. A mask specifying which fields (e.g. `expire_time`) in the Backup resource should be updated. This mask is relative to the Backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.", +"description": "Required. A mask specifying which fields (for example, `expire_time`) in the backup resource should be updated. This mask is relative to the backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1868,7 +1868,7 @@ ] }, "updateDdl": { -"description": "Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format `/operations/` and can be used to track execution of the schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response.", +"description": "Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format `/operations/` and can be used to track execution of the schema changes. The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl", "httpMethod": "PATCH", "id": "spanner.projects.instances.databases.updateDdl", @@ -3406,7 +3406,7 @@ } } }, -"revision": "20250708", +"revision": "20250920", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "AdaptMessageRequest": { @@ -3436,6 +3436,10 @@ "description": "Message sent by the adapter to the client.", "id": "AdaptMessageResponse", "properties": { +"last": { +"description": "Optional. Indicates whether this is the last AdaptMessageResponse in the stream. This field may be optionally set by the server. Clients should not rely on this field being set in all cases.", +"type": "boolean" +}, "payload": { "description": "Optional. Uninterpreted bytes from the underlying wire protocol.", "format": "byte", @@ -3656,7 +3660,7 @@ "type": "string" }, "instancePartitions": { -"description": "Output only. The instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup's `version_time`.", +"description": "Output only. The instance partition storing the backup. This is the same as the list of the instance partitions that the database recorded at the backup's `version_time`.", "items": { "$ref": "BackupInstancePartition" }, @@ -4093,6 +4097,11 @@ "precommitToken": { "$ref": "MultiplexedSessionPrecommitToken", "description": "If specified, transaction has not committed yet. You must retry the commit with the new precommit token." +}, +"snapshotTimestamp": { +"description": "If `TransactionOptions.isolation_level` is set to `IsolationLevel.REPEATABLE_READ`, then the snapshot timestamp is the timestamp at which all reads in the transaction ran. This timestamp is never returned.", +"format": "google-datetime", +"type": "string" } }, "type": "object" @@ -4163,12 +4172,12 @@ "Unspecified. Do not use.", "This is the default option for CopyBackup when encryption_config is not specified. For example, if the source backup is using `Customer_Managed_Encryption`, the backup will be using the same Cloud KMS key as the source backup.", "Use Google default encryption.", -"Use customer managed encryption. If specified, either `kms_key_name` or `kms_key_names` must contain valid Cloud KMS key(s)." +"Use customer managed encryption. If specified, either `kms_key_name` or `kms_key_names` must contain valid Cloud KMS keys." ], "type": "string" }, "kmsKeyName": { -"description": "Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", +"description": "Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", "type": "string" }, "kmsKeyNames": { @@ -4250,7 +4259,7 @@ "type": "string" }, "kmsKeyName": { -"description": "Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", +"description": "Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", "type": "string" }, "kmsKeyNames": { @@ -4729,18 +4738,18 @@ "id": "DdlStatementActionInfo", "properties": { "action": { -"description": "The action for the DDL statement, e.g. CREATE, ALTER, DROP, GRANT, etc. This field is a non-empty string.", +"description": "The action for the DDL statement, for example, CREATE, ALTER, DROP, GRANT, etc. This field is a non-empty string.", "type": "string" }, "entityNames": { -"description": "The entity name(s) being operated on the DDL statement. E.g. 1. For statement \"CREATE TABLE t1(...)\", `entity_names` = [\"t1\"]. 2. For statement \"GRANT ROLE r1, r2 ...\", `entity_names` = [\"r1\", \"r2\"]. 3. For statement \"ANALYZE\", `entity_names` = [].", +"description": "The entity names being operated on the DDL statement. For example, 1. For statement \"CREATE TABLE t1(...)\", `entity_names` = [\"t1\"]. 2. For statement \"GRANT ROLE r1, r2 ...\", `entity_names` = [\"r1\", \"r2\"]. 3. For statement \"ANALYZE\", `entity_names` = [].", "items": { "type": "string" }, "type": "array" }, "entityType": { -"description": "The entity type for the DDL statement, e.g. TABLE, INDEX, VIEW, etc. This field can be empty string for some DDL statement, e.g. for statement \"ANALYZE\", `entity_type` = \"\".", +"description": "The entity type for the DDL statement, for example, TABLE, INDEX, VIEW, etc. This field can be empty string for some DDL statement, for example, for statement \"ANALYZE\", `entity_type` = \"\".", "type": "string" } }, @@ -5511,7 +5520,7 @@ "id": "InstanceEncryptionConfig", "properties": { "kmsKeyName": { -"description": "Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. `kms_key_name` should only be used if the location of the KMS key matches the database instance\u2019s configuration (location) exactly. E.g. The KMS location is in us-central1 or nam3 and the database instance is also in us-central1 or nam3. The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", +"description": "Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", "type": "string" }, "kmsKeyNames": { @@ -5628,7 +5637,7 @@ "id": "InstanceReplicaSelection", "properties": { "location": { -"description": "Required. Name of the location of the replicas (e.g., \"us-central1\").", +"description": "Required. Name of the location of the replicas (for example, \"us-central1\").", "type": "string" } }, @@ -7113,7 +7122,7 @@ "type": "string" }, "kmsKeyName": { -"description": "Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored database. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", +"description": "Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", "type": "string" }, "kmsKeyNames": { @@ -7426,7 +7435,7 @@ "id": "SingleRegionQuorum", "properties": { "servingLocation": { -"description": "Required. The location of the serving region, e.g. \"us-central1\". The location must be one of the regions within the dual-region instance configuration of your database. The list of valid locations is available using the GetInstanceConfig API. This should only be used if you plan to change quorum to the single-region quorum type.", +"description": "Required. The location of the serving region, for example, \"us-central1\". The location must be one of the regions within the dual-region instance configuration of your database. The list of valid locations is available using the GetInstanceConfig API. This should only be used if you plan to change quorum to the single-region quorum type.", "type": "string" } }, @@ -7745,7 +7754,7 @@ "type": "array" }, "throttled": { -"description": "Output only. When true, indicates that the operation is throttled e.g. due to resource constraints. When resources become available the operation will resume and this field will be false again.", +"description": "Output only. When true, indicates that the operation is throttled, for example, due to resource constraints. When resources become available the operation will resume and this field will be false again.", "readOnly": true, "type": "boolean" } @@ -7753,7 +7762,7 @@ "type": "object" }, "UpdateDatabaseDdlRequest": { -"description": "Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (e.g., if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a `NULL` value in a column to which `NOT NULL` would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled. Each batch of statements is assigned a name which can be used with the Operations API to monitor progress. See the operation_id field for more details.", +"description": "Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (for example, if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a `NULL` value in a column to which `NOT NULL` would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled. Each batch of statements is assigned a name which can be used with the Operations API to monitor progress. See the operation_id field for more details.", "id": "UpdateDatabaseDdlRequest", "properties": { "operationId": { diff --git a/googleapiclient/discovery_cache/documents/speech.v1.json b/googleapiclient/discovery_cache/documents/speech.v1.json index 0bde2aa8e2..364a011eae 100644 --- a/googleapiclient/discovery_cache/documents/speech.v1.json +++ b/googleapiclient/discovery_cache/documents/speech.v1.json @@ -196,6 +196,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/operations", @@ -561,7 +566,7 @@ } } }, -"revision": "20241111", +"revision": "20250925", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ABNFGrammar": { @@ -762,6 +767,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json b/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json index 619a630879..ef80320145 100644 --- a/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json @@ -196,6 +196,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1p1beta1/operations", @@ -561,7 +566,7 @@ } } }, -"revision": "20241111", +"revision": "20250925", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ABNFGrammar": { @@ -762,6 +767,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json b/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json index 311a7ae2bd..e2ec8a2be9 100644 --- a/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json +++ b/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json @@ -465,6 +465,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -482,7 +487,7 @@ } } }, -"revision": "20250910", +"revision": "20250924", "rootUrl": "https://storagebatchoperations.googleapis.com/", "schemas": { "Bucket": { @@ -810,6 +815,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/vmwareengine.v1.json b/googleapiclient/discovery_cache/documents/vmwareengine.v1.json index 5169afa293..f6a2b094ad 100644 --- a/googleapiclient/discovery_cache/documents/vmwareengine.v1.json +++ b/googleapiclient/discovery_cache/documents/vmwareengine.v1.json @@ -169,7 +169,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -3396,7 +3396,7 @@ } } }, -"revision": "20250811", +"revision": "20250912", "rootUrl": "https://vmwareengine.googleapis.com/", "schemas": { "AcceleratePrivateCloudDeletionRequest": { diff --git a/googleapiclient/discovery_cache/documents/webrisk.v1.json b/googleapiclient/discovery_cache/documents/webrisk.v1.json index 68db15558e..12ab0c12df 100644 --- a/googleapiclient/discovery_cache/documents/webrisk.v1.json +++ b/googleapiclient/discovery_cache/documents/webrisk.v1.json @@ -258,6 +258,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -420,7 +425,7 @@ } } }, -"revision": "20241117", +"revision": "20250928", "rootUrl": "https://webrisk.googleapis.com/", "schemas": { "GoogleCloudWebriskV1ComputeThreatListDiffResponse": { @@ -699,6 +704,13 @@ "$ref": "GoogleLongrunningOperation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json index 3705652c11..a09c4133e4 100644 --- a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json @@ -373,6 +373,45 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"patch": { +"description": "Updates the parameters of a single Evaluation.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}", +"httpMethod": "PATCH", +"id": "workloadmanager.projects.locations.evaluations.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the Evaluation resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "Evaluation" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -879,7 +918,7 @@ true } } }, -"revision": "20250910", +"revision": "20250922", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { "AgentCommand": { @@ -1769,6 +1808,43 @@ true }, "type": "object" }, +"InvalidRule": { +"description": "Message represent an rule that failed to be validated.", +"id": "InvalidRule", +"properties": { +"displayName": { +"description": "display name of the invalid rule", +"type": "string" +}, +"gcsUri": { +"description": "cloud storage destination of the invalid rule", +"type": "string" +}, +"name": { +"description": "name of the invalid rule", +"type": "string" +}, +"valiadtionError": { +"description": "The error message of valdating rule formats.", +"type": "string" +} +}, +"type": "object" +}, +"InvalidRulesWrapper": { +"description": "Message wrappes a list of invalid rules.", +"id": "InvalidRulesWrapper", +"properties": { +"invalidRules": { +"description": "The invalid rules that failed to be validated.", +"items": { +"$ref": "InvalidRule" +}, +"type": "array" +} +}, +"type": "object" +}, "ListDiscoveredProfilesResponse": { "description": "List discovered profile Response returns discovered profiles from agents", "id": "ListDiscoveredProfilesResponse", @@ -1904,9 +1980,9 @@ true "description": "Mesesage of response of list rules", "id": "ListRulesResponse", "properties": { -"nextPageToken": { -"description": "A token identifying a page of results the server should return.", -"type": "string" +"invalidRulesWrapper": { +"$ref": "InvalidRulesWrapper", +"description": "A wrapper of the invalid rules that failed to be validated." }, "rules": { "description": "all rules in response", diff --git a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json index 523990d01c..b31367dee5 100644 --- a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json +++ b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json @@ -5,6 +5,9 @@ "https://www.googleapis.com/auth/chat.app.memberships": { "description": "On their own behalf, apps in Google Chat can see, add, update, and remove members from conversations and spaces" }, +"https://www.googleapis.com/auth/chat.app.messages.readonly": { +"description": "On their own behalf, apps in Google Chat can see all messages and their associated reactions and message content" +}, "https://www.googleapis.com/auth/chat.app.spaces": { "description": "On their own behalf, apps in Google Chat can create conversations and spaces and see or update their metadata (including history settings and access settings)" }, @@ -224,6 +227,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/chat.app.memberships", +"https://www.googleapis.com/auth/chat.app.messages.readonly", "https://www.googleapis.com/auth/chat.app.spaces", "https://www.googleapis.com/auth/chat.memberships", "https://www.googleapis.com/auth/chat.memberships.readonly", @@ -421,6 +425,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/chat.app.memberships", +"https://www.googleapis.com/auth/chat.app.messages.readonly", "https://www.googleapis.com/auth/chat.app.spaces", "https://www.googleapis.com/auth/chat.memberships", "https://www.googleapis.com/auth/chat.memberships.readonly", @@ -465,6 +470,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/chat.app.memberships", +"https://www.googleapis.com/auth/chat.app.messages.readonly", "https://www.googleapis.com/auth/chat.app.spaces", "https://www.googleapis.com/auth/chat.memberships", "https://www.googleapis.com/auth/chat.memberships.readonly", @@ -486,7 +492,7 @@ } } }, -"revision": "20250921", +"revision": "20250930", "rootUrl": "https://workspaceevents.googleapis.com/", "schemas": { "ListSubscriptionsResponse": {